1. class
  2. Comodojo
  3. \
  4. Zip
  5. \
  6. Zip

Zip

class Zip implements ZipInterface, Countable (View source)

comodojo/zip - ZipArchive toolbox

Traits

SkipTrait
Skip mode helper trait.
MaskTrait
File mask helper trait.
PasswordTrait
Password helper trait.
PathTrait
Path helper trait.
ArchiveTrait
Archive helper trait.
CommentTrait
Set/get the archive comment.

Methods

ZipInterface
setSkipMode(string $mode)

Set files to skip

from  SkipTrait
string
getSkipMode()

Get current skip mode

from  SkipTrait
ZipInterface
setMask(int $mask)

Set the mask of the extraction folder

from  MaskTrait
int
getMask()

Get current mask of the extraction folder

from  MaskTrait
ZipArchive|null
getArchive()

No description

from  CommentTrait
ZipInterface
setPassword(string $password)

Set zip password

from  PasswordTrait
string|null
getPassword()

Get current zip password

from  PasswordTrait
ZipInterface
setPath(string|null $path = null)

Set current base path (to add relative files to zip archive)

from  PathTrait
string|null
getPath()

Get current base path

from  PathTrait
ZipInterface
setArchive(ZipArchive $zip)

Set the current ZipArchive object

from  ArchiveTrait
ZipInterface
setComment(string $comment)

Set the comment for the current archive

from  CommentTrait
string|null
getComment()

Get the current zip archive comment

from  CommentTrait
__construct(string $zip_file)

Class constructor

static ZipInterface
open(string $zip_file)

Open a zip archive (static constructor)

static bool
check(string $zip_file)

Check a zip archive (static constructor)

static ZipInterface
create(string $zip_file, bool $overwrite = false)

Create a new zip archive (static constructor)

int
count()

Count the number of files in the archive

string
getZipFile()

Get current zip file

array
listFiles()

Get the list of files in the archive as an array

bool
extract(string $destination, mixed $files = null)

Extract files from zip archive

ZipInterface
add(mixed $file_name_or_array, bool $flatten_root_folder = false, int $compression = self::CM_DEFAULT, int $encryption = self::EM_NONE)

Add files to the ZipArchive

ZipInterface
delete(mixed $file_name_or_array)

Delete files from ZipArchive

bool
close()

Close the ZipArchive

Details

in SkipTrait at line 57
ZipInterface setSkipMode(string $mode)

Set files to skip

Supported skip modes: Zip::SKIP_NONE - skip no files Zip::SKIP_HIDDEN - skip hidden files Zip::SKIP_ALL - skip HIDDEN + COMODOJO ghost files Zip::SKIP_COMODOJO - skip comodojo ghost files

Parameters

string $mode Skip file mode

Return Value

ZipInterface

Exceptions

ZipException

in SkipTrait at line 75
string getSkipMode()

Get current skip mode

Return Value

string

in MaskTrait at line 42
ZipInterface setMask(int $mask)

Set the mask of the extraction folder

Parameters

int $mask Integer representation of the file mask

Return Value

ZipInterface

in MaskTrait at line 61
int getMask()

Get current mask of the extraction folder

Return Value

int

in CommentTrait at line 29
abstract ZipArchive|null getArchive()

Return Value

ZipArchive|null

in PasswordTrait at line 45
ZipInterface setPassword(string $password)

Set zip password

Parameters

string $password

Return Value

ZipInterface

in PasswordTrait at line 58
protected string|null getPassword()

Get current zip password

Return Value

string|null

in PathTrait at line 44
ZipInterface setPath(string|null $path = null)

Set current base path (to add relative files to zip archive)

Parameters

string|null $path

Return Value

ZipInterface

Exceptions

ZipException

in PathTrait at line 62
string|null getPath()

Get current base path

Return Value

string|null

in ArchiveTrait at line 43
ZipInterface setArchive(ZipArchive $zip)

Set the current ZipArchive object

Parameters

ZipArchive $zip

Return Value

ZipInterface

in CommentTrait at line 36
ZipInterface setComment(string $comment)

Set the comment for the current archive

Parameters

string $comment

Return Value

ZipInterface

in CommentTrait at line 47
string|null getComment()

Get the current zip archive comment

Return Value

string|null

at line 63
__construct(string $zip_file)

Class constructor

Parameters

string $zip_file ZIP file name

Exceptions

ZipException

at line 75
static ZipInterface open(string $zip_file)

Open a zip archive (static constructor)

Parameters

string $zip_file File name

Return Value

ZipInterface

Exceptions

ZipException

at line 86
static bool check(string $zip_file)

Check a zip archive (static constructor)

Parameters

string $zip_file ZIP file name

Return Value

bool

Exceptions

ZipException

at line 97
static ZipInterface create(string $zip_file, bool $overwrite = false)

Create a new zip archive (static constructor)

Parameters

string $zip_file ZIP file name
bool $overwrite Overwrite existing file (if any)

Return Value

ZipInterface

Exceptions

ZipException

at line 124
int count()

Count the number of files in the archive

Return Value

int

at line 137
string getZipFile()

Get current zip file

Return Value

string

at line 145
array listFiles()

Get the list of files in the archive as an array

Return Value

array

Exceptions

ZipException

at line 164
bool extract(string $destination, mixed $files = null)

Extract files from zip archive

Parameters

string $destination Destination path
mixed $files (optional) a filename or an array of filenames

Return Value

bool

Exceptions

ZipException

at line 200
ZipInterface add(mixed $file_name_or_array, bool $flatten_root_folder = false, int $compression = self::CM_DEFAULT, int $encryption = self::EM_NONE)

Add files to the ZipArchive

Parameters

mixed $file_name_or_array Filename to add or an array of filenames
bool $flatten_root_folder In case of directory, specify if root folder should be flatten or not
int $compression Compression algorithm to use (default CM_DEFAULT)
int $encryption

Return Value

ZipInterface

Exceptions

ZipException

at line 231
ZipInterface delete(mixed $file_name_or_array)

Delete files from ZipArchive

Parameters

mixed $file_name_or_array Filename to delete or an array of filenames

Return Value

ZipInterface

Exceptions

ZipException

at line 251
bool close()

Close the ZipArchive

Return Value

bool

Exceptions

ZipException