The PharData class

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 {

/* Properties */

/* Methods */

bool addEmptyDir ( string $dirname )

void Phar::addFile ( string $file [, string $localname ] )

bool addFromString ( string $localname , string $contents )

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 )

void __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 )

int delMetadata ( void )

int delete ( string $entry )

int extractTo ( string $pathto [, string|array $files [, bool $overwrite ]] )

bool isWritable ( void )

void offsetSet ( string $offset , string $value )

bool offsetUnset ( string $offset )

bool setAlias ( string $alias )

void setDefaultStub ([ string $index [, string $webindex ]] )

void Phar::setMetadata ( mixed $metadata )

void Phar::setSignatureAlgorithm ( int $sigtype )

void setStub ( string $stub )

/* Inherited methods */

void Phar::addEmptyDir ( string $dirname )

void Phar::addFile ( string $file [, string $localname ] )

void Phar::addFromString ( string $localname , string $contents )

string Phar::apiVersion ( void )

array Phar::buildFromDirectory ( string $base_dir [, string $regex ] )

array Phar::buildFromIterator ( Iterator $iter [, string $base_directory ] )

bool Phar::canCompress ([ int $type = 0 ] )

bool Phar::canWrite ( void )

object Phar::compress ( int $compression [, string $extension ] )

bool Phar::compressAllFilesBZIP2 ( void )

bool Phar::compressAllFilesGZ ( void )

void Phar::compressFiles ( int $compression )

void Phar::__construct ( string $fname [, int $flags [, string $alias ]] )

PharData Phar::convertToData ([ int $format = 9021976 [, int $compression = 9021976 [, string $extension ]]] )

Phar Phar::convertToExecutable ([ int $format = 9021976 [, int $compression = 9021976 [, string $extension ]]] )

bool Phar::copy ( string $oldfile , string $newfile )

int Phar::count ( void )

string Phar::createDefaultStub ([ string $indexfile [, string $webindexfile ]] )

object Phar::decompress ([ string $extension ] )

bool Phar::decompressFiles ( void )

bool Phar::delMetadata ( void )

bool Phar::delete ( string $entry )

bool Phar::extractTo ( string $pathto [, string|array $files [, bool $overwrite = false ]] )

mixed Phar::getMetaData ( void )

bool Phar::getModified ( void )

array Phar::getSignature ( void )

string Phar::getStub ( void )

array Phar::getSupportedCompression ( void )

array Phar::getSupportedSignatures ( void )

string Phar::getVersion ( void )

bool Phar::hasMetadata ( void )

void Phar::interceptFileFuncs ( void )

bool Phar::isBuffering ( void )

mixed Phar::isCompressed ( void )

bool Phar::isFileFormat ( int $format )

bool Phar::isValidPharFilename ( string $filename [, bool $executable = true ] )

bool Phar::isWritable ( void )

bool Phar::loadPhar ( string $filename [, string $alias ] )

bool Phar::mapPhar ([ string $alias [, int $dataoffset = 0 ]] )

void Phar::mount ( string $pharpath , string $externalpath )

void Phar::mungServer ( array $munglist )

bool Phar::offsetExists ( string $offset )

int Phar::offsetGet ( string $offset )

void Phar::offsetSet ( string $offset , string $value )

bool Phar::offsetUnset ( string $offset )

string Phar::running ([ bool $retphar = true ] )

bool Phar::setAlias ( string $alias )

bool Phar::setDefaultStub ([ string $index [, string $webindex ]] )

void Phar::setMetadata ( mixed $metadata )

void Phar::setSignatureAlgorithm ( int $sigtype [, string $privatekey ] )

bool Phar::setStub ( string $stub )

void Phar::startBuffering ( void )

void Phar::stopBuffering ( void )

bool Phar::uncompressAllFiles ( void )

bool Phar::unlinkArchive ( string $archive )

void Phar::webPhar ([ string $alias [, string $index = "index.php" [, string $f404 [, array $mimetypes [, array $rewrites ]]]]] )

}