Function __global->tar_open
Definitions
sources/tar.php
- Open up a TAR archive (or tarball if the zlib extension is available and .gz is requested), and return the resource.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $path | PATH | required parameter | N/A | N/A | The path to the TAR archive; for a write operation can be php://output given TAR is a streamable format |
| $mode | string | required parameter | N/A | N/A | The mode to open the TAR archive (rb=read, wb=write) |
| $known_exists | boolean | False | N/A | N/A | Whether we know the file currently exists (performance optimisation) |
| $real_filename | ?string | Null | N/A | N/A | The real filename of the TAR file (null: derive from $path) |
Return
- The TAR file handle
- Type: array
- Set: N/A
- Range: N/A