ZipFile

ZipFile class allows to open files inside a zip file with the standard php zip functions

This class also supports adding/replacing/deleting files inside the zip file, but changes will not be reflected correctly until you close the zip file, and open it again if needed

Note: this is not meant to handle a massive amount of files inside generic archive files. It is specifically meant for EPUB files which typically contain hundreds/thousands of pages, not millions or more. And any changes you make are kept in memory, so don't re-write every page of War and Peace either - better to unzip that locally and then re-zip it afterwards.

• Full name: \SebLucas\EPubMeta\Tools\ZipFile

Constants

Constant	Visibility	Type	Value
DOWNLOAD	public		1
NOHEADER	public		4
FILE	public		8
STRING	public		32
MIME_TYPE	public		'application/epub+zip'

Properties

mZip

protected \ZipArchive|null $mZip

---

mEntries

protected array<string,mixed>|null $mEntries

---

mChanges

protected array<string,mixed> $mChanges

---

mFileName

protected string|null $mFileName

---

Methods

__construct

public __construct(): mixed

---

__destruct

Destructor

public __destruct(): mixed

---

Open

Open a zip file and read it's entries

public Open(string $inFileName, int|null $inFlags): bool

Parameters:

Parameter	Type	Description
$inFileName	string
$inFlags	int|null

Return Value:

True if zip file has been correctly opended, else false

---

FileExists

Check if a file exist in the zip entries

public FileExists(string $inFileName): bool

Parameters:

Parameter	Type	Description
$inFileName	string	File to search

Return Value:

True if the file exist, else false

---

FileRead

Read the content of a file in the zip entries

public FileRead(string $inFileName): mixed

Parameters:

Parameter	Type	Description
$inFileName	string	File to search

Return Value:

File content the file exist, else false

---

FileStream

Get a file handler to a file in the zip entries (read-only)

public FileStream(string $inFileName): resource|bool

Parameters:

Parameter	Type	Description
$inFileName	string	File to search

Return Value:

File handler if the file exist, else false

---

FileAdd

Summary of FileAdd

public FileAdd(string $inFileName, mixed $inData): bool

Parameters:

Parameter	Type	Description
$inFileName	string
$inData	mixed

---

FileAddPath

Summary of FileAddPath

public FileAddPath(string $inFileName, string $inFilePath): mixed

Parameters:

Parameter	Type	Description
$inFileName	string
$inFilePath	string

---

FileDelete

Summary of FileDelete

public FileDelete(string $inFileName): bool

Parameters:

Parameter	Type	Description
$inFileName	string

---

FileReplace

Replace the content of a file in the zip entries

public FileReplace(string $inFileName, string|bool $inData): bool

Parameters:

Parameter	Type	Description
$inFileName	string	File with content to replace
$inData	string|bool	Data content to replace, or false to delete

---

FileGetState

Return the state of the file.

public FileGetState(mixed $inFileName): string|bool

Parameters:

Parameter	Type	Description
$inFileName	mixed

Return Value:

'u'=unchanged, 'm'=modified, 'd'=deleted, 'a'=added, false=unknown

---

FileCancelModif

Summary of FileCancelModif

public FileCancelModif(string $inFileName, bool $ReplacedAndDeleted = true): int

Parameters:

Parameter	Type	Description
$inFileName	string
$ReplacedAndDeleted	bool

---

Close

Close the zip file

public Close(): void

Throws:

• Exception

---

Flush

Summary of Flush

public Flush(mixed $render = self::DOWNLOAD, mixed $outFileName = '', mixed $contentType = '', bool $sendHeaders = true): void

Parameters:

Parameter	Type	Description
$render	mixed
$outFileName	mixed
$contentType	mixed
$sendHeaders	bool

---

---

Automatically generated on 2025-03-18