Phar
PHP Manual

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
PharData extends Phar {
/* Properties */
/* Methods */
bool PharData::addEmptyDir ( string $dirname )
bool Phar::addFile ( string $file [, string $localname ] )
bool PharData::addFromString ( string $localname , string $contents )
array Phar::buildFromDirectory ( string $base_dir [, string $regex ] )
array PharData::buildFromIterator ( Iterator $iter [, string $base_directory ] )
object PharData::compress ( int $compression , string $extension )
bool PharData::compressFiles ( int $compression )
void PharData::__construct ( string $fname [, int $flags ] )
PharData PharData::convertToData ([ int $format [, int $compression [, string $extension ]]] )
Phar PharData::convertToExecutable ([ int $format [, int $compression [, string $extension ]]] )
bool PharData::copy ( string $oldfile , string $newfile )
object PharData::decompress ([ string $extension ] )
int PharData::delMetadata ( void )
int PharData::delete ( string $entry )
int PharData::extractTo ( string $pathto [, string|array $files [, bool $overwrite ]] )
bool PharData::isWritable ( void )
void PharData::offsetSet ( string $offset , string $value )
bool PharData::offsetUnset ( string $offset )
bool PharData::setAlias ( string $alias )
void PharData::setDefaultStub ([ string $index [, string $webindex ]] )
void Phar::setMetadata ( mixed $metadata )
array Phar::setSignatureAlgorithm ( int $sigtype )
void PharData::setStub ( string $stub )
/* Inherited methods */
bool Phar::addEmptyDir ( string $dirname )
bool Phar::addFile ( string $file [, string $localname ] )
bool 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 ] )
bool Phar::canWrite ( void )
object Phar::compress ( int $compression [, string $extension ] )
bool Phar::compressFiles ( int $compression )
void Phar::__construct ( string $fname [, int $flags [, string $alias ]] )
PharData Phar::convertToData ([ int $format [, int $compression [, string $extension ]]] )
Phar Phar::convertToExecutable ([ int $format [, int $compression [, string $extension ]]] )
bool Phar::copy ( string $oldfile , string $newfile )
int Phar::count ( void )
string Phar::createDefaultStub ( void )
object Phar::decompress ([ string $extension ] )
bool Phar::decompressFiles ( void )
int Phar::delMetadata ( void )
int Phar::delete ( string $entry )
int Phar::extractTo ( string $pathto [, string|array $files [, bool $overwrite ]] )
int Phar::getMetaData ( void )
bool Phar::getModified ( void )
array Phar::getSignature ( void )
string Phar::getStub ( void )
string Phar::getVersion ( void )
int Phar::hasMetadata ( void )
bool Phar::isBuffering ( void )
mixed Phar::isCompressed ( void )
bool Phar::isFileFormat ( int $format )
bool Phar::isValidPharFilename ( string $filename [, bool $executable ] )
bool Phar::isWritable ( void )
mixed Phar::loadPhar ( string $filename [, string $alias ] )
mixed Phar::mapPhar ([ string $alias [, int $dataoffset ]] )
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 )
bool Phar::running ([ bool $retphar ] )
bool Phar::setAlias ( string $alias )
void Phar::setDefaultStub ([ string $index [, string $webindex ]] )
void Phar::setMetadata ( mixed $metadata )
array Phar::setSignatureAlgorithm ( int $sigtype [, string $privatekey ] )
void Phar::setStub ( string $stub )
void Phar::startBuffering ( void )
void Phar::stopBuffering ( void )
bool Phar::unlinkArchive ( string $archive )
void Phar::webPhar ( string $alias , string $index , string $f404 , array $mimetypes , array $rewrites )
}

Table of Contents


Phar
PHP Manual