Function __global->tar_add_folder
Definitions
sources/tar.php
- Add a folder to the TAR archive.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $resource | array | required parameter | N/A | N/A | The TAR file handle |
| $log_file | ?resource | required parameter | N/A | N/A | The logfile to write to (null: no logging) |
| $path | PATH | required parameter | N/A | N/A | The full path to the folder to add |
| $max_size | ?integer | Null | N/A | N/A | The maximum file size to add (null: no limit) |
| $subpath | PATH | Blank (empty string) | N/A | N/A | The subpath relative to the path (should be left as the default '', as this is used for the recursion to distinguish the adding base path from where it's currently looking) |
| $avoid_backing_up | array | [] | N/A | N/A | A map (filename=>true) of files to not back up |
| $root_only_dirs | ?array | Null | N/A | N/A | A list of directories ONLY to back up from the root (null: no restriction) |
| $tick | boolean | False | N/A | N/A | Whether to output spaces as we go to keep the connection alive |
| $ignore_bitmask | ?integer | 0 | N/A | N/A | Bitmask of extra stuff to ignore (see IGNORE_* constants) (null: don't ignore anything) |
| $callback | ?mixed | Null | N/A | N/A | Callback to run on each iteration (null: none) |