Phar::webPhar
PharData::addEmptyDir
Phar
PHP Manual

# The PharData class

(PHP >= 5.3.0, PECL phar >= 2.0.0)

## Introduction

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

PharData extends Phar {
/* Methods */
bool addEmptyDir ( string `$dirname` )
public void Phar::addFile ( string `$file` [, string `$localname` ] )
bool addFromString ( string `$localname` , string `$contents` )
public array Phar::buildFromDirectory ( string `$base_dir` [, string `$regex` ] )
array buildFromIterator ( Iterator `$iter` [, string `$base_directory` ] )
object compress ( int `$compression` [, string `$extension` ] )
bool compressFiles ( int `$compression` )
__construct ( string `$fname` [, int `$flags` [, string `$alias` [, int `$format` = `Phar::TAR` ]]] )
PharData convertToData ([ int `$format` [, int `$compression` [, string `$extension` ]]] )
Phar convertToExecutable ([ int `$format` [, int `$compression` [, string `$extension` ]]] )
bool copy ( string `$oldfile` , string `$newfile` )
object decompress ([ string `$extension` ] )
bool decompressFiles ( void )
bool delMetadata ( void )
bool delete ( string `$entry` )
bool extractTo ( string `$pathto` [, string|array `$files` [, bool `$overwrite` = false ]] )
bool isWritable ( void )
void offsetSet ( string `$offset` , string `$value` )
bool offsetUnset ( string `$offset` )
bool setAlias ( string `$alias` )
bool setDefaultStub ([ string `$index` [, string `$webindex` ]] )
public void Phar::setMetadata ( mixed `$metadata` )
public void Phar::setSignatureAlgorithm ( int `$sigtype` )
bool setStub ( string `$stub` [, int `$len` = -1 ] )
/* Inherited methods */
public void Phar::addEmptyDir ( string `$dirname` )
public void Phar::addFile ( string `$file` [, string `$localname` ] )
public void Phar::addFromString ( string `$localname` , string `$contents` )
final public static string Phar::apiVersion ( void )
public array Phar::buildFromDirectory ( string `$base_dir` [, string `$regex` ] )
public array Phar::buildFromIterator ( Iterator `$iter` [, string `$base_directory` ] )
final public static bool Phar::canCompress ([ int `$type` = 0 ] )
final public static bool Phar::canWrite ( void )
public object Phar::compress ( int `$compression` [, string `$extension` ] )
public bool Phar::compressAllFilesBZIP2 ( void )
public bool Phar::compressAllFilesGZ ( void )
public void Phar::compressFiles ( int `$compression` )
public Phar::__construct ( string `$fname` [, int `$flags` [, string `$alias` ]] )
public PharData Phar::convertToData ([ int `$format` = 9021976 [, int `$compression` = 9021976 [, string `$extension` ]]] )
public Phar Phar::convertToExecutable ([ int `$format` = 9021976 [, int `$compression` = 9021976 [, string `$extension` ]]] )
public bool Phar::copy ( string `$oldfile` , string `$newfile` )
public int Phar::count ( void )
final public static string Phar::createDefaultStub ([ string `$indexfile` [, string `$webindexfile` ]] )
public object Phar::decompress ([ string `$extension` ] )
public bool Phar::decompressFiles ( void )
public bool Phar::delMetadata ( void )
public bool Phar::delete ( string `$entry` )
public bool Phar::extractTo ( string `$pathto` [, string|array `$files` [, bool `$overwrite` = false ]] )
public mixed Phar::getMetadata ( void )
public bool Phar::getModified ( void )
public array Phar::getSignature ( void )
public string Phar::getStub ( void )
final public static array Phar::getSupportedCompression ( void )
final public static array Phar::getSupportedSignatures ( void )
public string Phar::getVersion ( void )
public bool Phar::hasMetadata ( void )
final public static void Phar::interceptFileFuncs ( void )
public bool Phar::isBuffering ( void )
public mixed Phar::isCompressed ( void )
public bool Phar::isFileFormat ( int `$format` )
final public static bool Phar::isValidPharFilename ( string `$filename` [, bool `$executable` = true ] )
public bool Phar::isWritable ( void )
final public static bool Phar::loadPhar ( string `$filename` [, string `$alias` ] )
final public static bool Phar::mapPhar ([ string `$alias` [, int `$dataoffset` = 0 ]] )
final public static void Phar::mount ( string `$pharpath` , string `$externalpath` )
final public static void Phar::mungServer ( array `$munglist` )
public bool Phar::offsetExists ( string `$offset` )
public int Phar::offsetGet ( string `$offset` )
public void Phar::offsetSet ( string `$offset` , string `$value` )
public bool Phar::offsetUnset ( string `$offset` )
final public static string Phar::running ([ bool `$retphar` = true ] )
public bool Phar::setAlias ( string `$alias` )
public bool Phar::setDefaultStub ([ string `$index` [, string `$webindex` ]] )
public void Phar::setMetadata ( mixed `$metadata` )
public void Phar::setSignatureAlgorithm ( int `$sigtype` [, string `$privatekey` ] )
public bool Phar::setStub ( string `$stub` [, int `$len` = -1 ] )
public void Phar::startBuffering ( void )
public void Phar::stopBuffering ( void )
public bool Phar::uncompressAllFiles ( void )
final public static bool Phar::unlinkArchive ( string `$archive` )
final public static void Phar::webPhar ([ string `$alias` [, string `$index` = "index.php" [, string `$f404` [, array `$mimetypes` [, callable `$rewrites` ]]]]] )
}

## Table of Contents

- 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 the filesystem 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::__construct — Construct a non-executable tar or zip archive object
- 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 phar archive to another new file within the phar
- 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)
- Phar::setMetadata — Sets phar archive meta-data
- Phar::setSignatureAlgorithm — set the signature algorithm for a phar and apply it.
- PharData::setStub — dummy function (Phar::setStub is not valid for PharData)

Phar::webPhar
PharData::addEmptyDir
Phar
PHP Manual