October\Rain\Filesystem\Zip

Overview

Zip helper

Extends

• ZipArchive

Implements

• Countable

Public Properties

There are no public properties in the class.

Show inherited public properties

Protected Properties

protected string $folderPrefix

protected array $excludedFiles

protected array $excludedFolders

Public Methods

public add()

public add(mixed $source, array $options = []): self 

add includes a source to the Zip

public exclude()

public exclude($paths): void 

exclude paths from inclusion in the zip file

public static extract()

public static extract(
    string $source,
    string $destination,
    array $options = []
): bool 

extract an existing zip file.

public folder()

public folder(string $name, mixed $source = null): self 

folder creates a new folder inside the Zip and adds source files (optional)

public isExcluded()

public isExcluded($path): bool 

isExcluded checks if a path is excluded

public static make()

public static make(
    string $destination,
    mixed $source,
    array $options = []
): self 

make creates a new empty zip file.

public remove()

public remove(string $source): self 

remove a file or folder from the zip collection. Does not support wildcards.

Show inherited public methods

Protected Methods

protected removePathPrefix()

protected removePathPrefix(string $prefix, string $path): string 

removePathPrefix removes a prefix from a path.