Phar::webPhar
PharData::addEmptyDir
Phar
PHP Manual

# PharData クラス

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

## 導入

PharData クラスは、実行可能形式でない tar アーカイブや zip アーカイブへのアクセスや作成のための高レベルインターフェイスを提供します。 これらのアーカイブにはスタブが含まれておらず、 phar 拡張モジュールから実行することはできません。 そのため、PharData クラスによる通常の zip および tar ファイルの作成や 操作は php.ini の phar.readonly が 1 であっても可能です。

## クラス概要

PharData extends Phar {
/* メソッド */
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 ] )
/* 継承したメソッド */
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` ]]]]] )
}

## 目次

- PharData::addEmptyDir — 空のディレクトリを tar/zip アーカイブに追加する
- PharData::addFile — ファイルシステム上のファイルを tar/zip アーカイブに追加する
- PharData::addFromString — ファイルシステム上のファイルを tar/zip アーカイブに追加する
- PharData::buildFromDirectory — ディレクトリ内のファイルから tar/zip アーカイブを作成する
- PharData::buildFromIterator — イテレータから tar あるいは zip アーカイブを作成する
- PharData::compress — tar/zip アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
- PharData::compressFiles — 現在の tar/zip アーカイブ内のすべてのファイルを圧縮する
- PharData::__construct — 実行可能でない tar あるいは zip アーカイブオブジェクトを作成する
- PharData::convertToData — phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する
- PharData::convertToExecutable — 実行可能でない tar/zip アーカイブを実行可能な phar アーカイブ形式に変換する
- PharData::copy — phar アーカイブ内のファイルを、phar 内で別の新しいファイルとしてコピーする
- PharData::decompress — Phar アーカイブ全体の圧縮を解除する
- PharData::decompressFiles — 現在の zip アーカイブ内のすべてのファイルの圧縮を解除する
- PharData::delMetadata — zip アーカイブのグローバルメタデータを削除する
- PharData::delete — tar/zip アーカイブ内のファイルを削除する
- PharData::extractTo — tar/zip アーカイブの内容をディレクトリに展開する
- PharData::isWritable — tar/zip アーカイブが変更可能な場合に true を返す
- PharData::offsetSet — tar/zip の内部のファイルに、外部ファイルあるいは文字列の内容を設定する
- PharData::offsetUnset — ファイルを tar/zip アーカイブから削除する
- PharData::setAlias — ダミー関数 (Phar::setAlias は PharData では使用不能)
- PharData::setDefaultStub — ダミー関数 (Phar::setDefaultStub は PharData では無効)
- Phar::setMetadata — phar アーカイブのメタデータを設定する
- Phar::setSignatureAlgorithm — phar のシグネチャのアルゴリズムを設定する
- PharData::setStub — ダミー関数 (Phar::setStub は PharData では使用不能)

Phar::webPhar
PharData::addEmptyDir
Phar
PHP Manual