php8.5
/
Download
Home/ Manual/ reference / phar/ The PharData class

The PharData class

Guide Edit on GitHub ✎

The PharData class provides a high-level interface to accessing and creating non-executable tar and zip archives. Because these archives do not contain a stub and cannot be executed by the phar extension, it is possible to create and manipulate regular zip and tar files using the PharData class even if phar.readonly php.ini setting is 1.

Intro

The PharData class provides a high-level interface to accessing and creating non-executable tar and zip archives. Because these archives do not contain a stub and cannot be executed by the phar extension, it is possible to create and manipulate regular zip and tar files using the PharData class even if phar.readonly php.ini setting is 1.

Class synopsis

class PharData extends RecursiveDirectoryIterator implements Countable implements ArrayAccess { }

PharData

In this section

PharData::__construct

Construct a non-executable tar or zip archive object

PharData::__destruct

Destructs a non-executable tar or zip archive object

PharData::addEmptyDir

Add an empty directory to the tar/zip archive

PharData::addFile

Add a file from the filesystem to the tar/zip archive

PharData::addFromString

Add a file from a string to the tar/zip archive

PharData::buildFromDirectory

Construct a tar/zip archive from the files within a directory

PharData::buildFromIterator

Construct a tar or zip archive from an iterator

PharData::compress

Compresses the entire tar/zip archive using Gzip or Bzip2 compression

PharData::compressFiles

Compresses all files in the current tar/zip archive

PharData::convertToData

Convert a phar archive to a non-executable tar or zip file

PharData::convertToExecutable

Convert a non-executable tar/zip archive to an executable phar archive

PharData::copy

Copy a file internal to the tar/zip archive to another new file within the same archive

PharData::decompress

Decompresses the entire Phar archive

PharData::decompressFiles

Decompresses all files in the current zip archive

PharData::delMetadata

Deletes the global metadata of a zip archive

PharData::delete

Delete a file within a tar/zip archive

PharData::extractTo

Extract the contents of a tar/zip archive to a directory

PharData::isWritable

Returns true if the tar/zip archive can be modified

PharData::offsetSet

Set the contents of a file within the tar/zip to those of an external file or string

PharData::offsetUnset

Remove a file from a tar/zip archive

PharData::setAlias

Dummy function (Phar::setAlias is not valid for PharData)

PharData::setDefaultStub

Dummy function (Phar::setDefaultStub is not valid for PharData)

PharData::setMetadata

Sets phar archive meta-data

PharData::setSignatureAlgorithm

Set the signature algorithm for a phar and apply it

PharData::setStub

Dummy function (Phar::setStub is not valid for PharData)

Source: reference/phar/PharData.xml · from the official PHP manual (php/doc-en)