Layer: Core · Source: lib/core/HZip.php:16 (lines 16–64)

class HZip

HZip Class

Zip a folder (include itself) Usage :

    HZip::zipDir('/path/to/sourceDir', '/path/to/out.zip');

No parent, interface or trait. This is a root type.

None.

None declared.

^ Visibility ^ Method ^ Summary ^ Line ^
| private static | ''folderToZip()'' | Add files and sub-directories in a folder to zip file. | 24 |
| public static | ''zipDir()'' | Zip a folder (include itself). | 52 |

private static function folderToZip($folder, &$zipFile, $exclusiveLength)

lines 24–42 (19)

Add files and sub-directories in a folder to zip file.

^ Parameter ^ Type ^ Default ^ Description ^
| ''$folder'' | ''(untyped)'' | //required// | //none// |
| ''$zipFile (by reference)'' | ''(untyped)'' | //required// | //none// |
| ''$exclusiveLength'' | ''(untyped)'' | //required// | Number of text to be exclusived from the file path. |

Returns: (none declared)

public static function zipDir($sourcePath, $outZipPath)

lines 52–63 (12)

Zip a folder (include itself).

Usage:

HZip::zipDir('/path/to/sourceDir', '/path/to/out.zip');

^ Parameter ^ Type ^ Default ^ Description ^
| ''$sourcePath'' | ''(untyped)'' | //required// | Path of directory to be zip. |
| ''$outZipPath'' | ''(untyped)'' | //required// | Path of output zip file. |

Returns: (none declared)

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.