Function __global->tar_get_file
Definitions
sources/tar.php
- Get the contents of the specified file in the specified TAR.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $resource | array | required parameter | N/A | N/A | The TAR file handle |
| $path | PATH | required parameter | N/A | N/A | The full path to the file we want to get |
| $tolerate_errors | boolean | False | N/A | N/A | Whether to tolerate errors (returns null if error) |
| $write_data_to | ?PATH | Null | N/A | N/A | Write data to here (null: return within array) |
Return
- A map, containing 'data' (the file), 'size' (the filesize), 'mtime' (the modification timestamp), and 'mode' (the permissions) (null: not found / TAR possibly corrupt if we turned tolerate errors on)
- Type: ?array
- Set: N/A
- Range: N/A