導入

Last updated: Fri, 29 Aug 2008

Phar

phpdoc:classref

Phar クラス

導入

Phar クラスは、phar アーカイブへのアクセスや作成のための高レベルインターフェイスを提供します。

クラス概要

Phar

class Phar extends DirectoryIterator implements Countable , ArrayAccess {

/* プロパティ */

/* メソッド */

bool addEmptyDir ( string $dirname )

bool addFile ( string $file [, string $localname ] )

bool addFromString ( string $localname , string $contents )

string apiVersion ( void )

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

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

bool canCompress ([ int $type ] )

bool canWrite ( void )

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

bool compressAllFilesBZIP2 ( void )

bool compressAllFilesGZ ( void )

bool compressFiles ( int $compression )

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

PharData convertToData ([ int $format [, int $compression [, string $extension ]]] )

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

bool copy ( string $oldfile , string $newfile )

int count ( void )

string createDefaultStub ( void )

object decompress ([ string $extension ] )

bool decompressFiles ( void )

int delMetadata ( void )

int delete ( string $entry )

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

int getMetaData ( void )

bool getModified ( void )

array getSignature ( void )

string getStub ( void )

array getSupportedCompression ( void )

array getSupportedSignatures ( void )

string getVersion ( void )

int hasMetadata ( void )

void interceptFileFuncs ( void )

bool isBuffering ( void )

mixed isCompressed ( void )

bool isFileFormat ( int $format )

bool isValidPharFilename ( string $filename [, bool $executable ] )

bool isWritable ( void )

mixed loadPhar ( string $filename [, string $alias ] )

mixed mapPhar ([ string $alias [, int $dataoffset ]] )

void mount ( string $pharpath , string $externalpath )

void mungServer ( array $munglist )

bool offsetExists ( string $offset )

int offsetGet ( string $offset )

void offsetSet ( string $offset , string $value )

bool offsetUnset ( string $offset )

bool running ([ bool $retphar ] )

bool setAlias ( string $alias )

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

void setMetadata ( mixed $metadata )

array setSignatureAlgorithm ( int $sigtype [, string $privatekey ] )

void setStub ( string $stub )

void startBuffering ( void )

void stopBuffering ( void )

bool uncompressAllFiles ( void )

bool unlinkArchive ( string $archive )

void webPhar ( string $alias , string $index , string $f404 , array $mimetypes , array $rewrites )

}

/phpdoc:classref phpdoc:classref

PharData クラス

導入

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

クラス概要

PharData

class PharData extends Phar {

/* プロパティ */

/* メソッド */

bool addEmptyDir ( string $dirname )

bool 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 ] )

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 )

array Phar::setSignatureAlgorithm ( int $sigtype )

void setStub ( string $stub )

/* 継承したメソッド */

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::compressAllFilesBZIP2 ( void )

bool Phar::compressAllFilesGZ ( void )

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 )

array Phar::getSupportedCompression ( void )

array Phar::getSupportedSignatures ( void )

string Phar::getVersion ( void )

int 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 ] )

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::uncompressAllFiles ( void )

bool Phar::unlinkArchive ( string $archive )

void Phar::webPhar ( string $alias , string $index , string $f404 , array $mimetypes , array $rewrites )

}

/phpdoc:classref phpdoc:classref

PharFileInfo クラス

導入

PharFileInfo クラスは、 phar アーカイブ内の個々のファイルのコンテンツや属性への高レベルインターフェイスを提供します。

クラス概要

PharFileInfo

class PharFileInfo extends SplFileInfo {

/* プロパティ */

/* メソッド */

void chmod ( int $permissions )

bool compress ( int $compression )

void __construct ( string $entry )

bool decompress ( void )

bool delMetadata ( void )

int getCRC32 ( void )

int getCompressedSize ( void )

int getMetaData ( void )

int getPharFlags ( void )

int hasMetadata ( void )

bool isCRCChecked ( void )

bool isCompressed ( void )

bool isCompressedBZIP2 ( void )

bool isCompressedGZ ( void )

bool setCompressedBZIP2 ( void )

bool setCompressedGZ ( void )

void setMetaData ( mixed $metadata )

bool setUncompressed ( void )

}

/phpdoc:classref phpdoc:exceptionref

PharException クラス

導入

PharException クラスは、try/catch ブロックで使用するための phar 固有の例外クラスです。

クラス概要

PharException

class PharException extends Exception {

/* プロパティ */

}

/phpdoc:exceptionref

導入
インストール/設定
- インストール手順
- 実行時設定
- リソース型
定義済み定数
Phar アーカイブの使用法
- Phar アーカイブの使用法: phar ストリームラッパー
- Phar アーカイブの使用法: Phar クラスおよび PharData クラス
Phar アーカイブの作成
phar って、tar や zip とは何が違うの?
- Phar ファイルのスタブ
- Phar 形式と Tar 形式、Zip 形式の徹底比較
- Tar 形式の phar アーカイブ
- Zip 形式の phar アーカイブ
- Phar ファイルフォーマット
- グローバルな Phar ビットマップフラグ
- Phar のシグネチャの書式
Phar::addEmptyDir — 空のディレクトリを phar アーカイブに追加する
Phar::addFile — ファイルシステム上のファイルを phar アーカイブに追加する
Phar::addFromString — ファイルシステム上のファイルを phar アーカイブに追加する
Phar::apiVersion — API のバージョンを返す
Phar::buildFromDirectory — ディレクトリ内のファイルから phar を作成する
Phar::buildFromIterator — イテレータから phar アーカイブを作成する
Phar::canCompress — phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す
Phar::canWrite — phar 拡張モジュールが phar の書き込みや作成をサポートしているかどうかを返す
Phar::compress — Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
Phar::compressAllFilesBZIP2 — 現在の Phar アーカイブ内のすべてのファイルを Bzip2 で圧縮する
Phar::compressAllFilesGZ — 現在の Phar アーカイブ内のすべてのファイルを Gzip で圧縮する
Phar::compressFiles — 現在の Phar アーカイブ内のすべてのファイルを圧縮する
Phar::__construct — Phar アーカイブオブジェクトを作成する
Phar::convertToData — phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する
Phar::convertToExecutable — phar アーカイブを実行可能な別の phar アーカイブ形式に変換する
Phar::copy — phar アーカイブ内のファイルを、phar 内で別の新しいファイルとしてコピーする
Phar::count — Phar アーカイブ内のエントリ (ファイル) の数を返す
Phar::createDefaultStub — Phar アーカイブの PHP ローダーあるいは起動スタブを返す
Phar::decompress — Phar アーカイブ全体の圧縮を解除する
Phar::decompressFiles — 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
Phar::delMetadata — phar のグローバルメタデータを削除する
Phar::delete — phar アーカイブ内のファイルを削除する
Phar::extractTo — phar アーカイブの内容をディレクトリに展開する
Phar::getMetaData — phar アーカイブのメタデータを返す
Phar::getModified — phar が変更されているかどうかを返す
Phar::getSignature — Phar アーカイブの MD5/SHA1/SHA256/SHA512 シグネチャを返す
Phar::getStub — Phar アーカイブの PHP ローダーあるいは起動スタブを返す
Phar::getSupportedCompression — サポートする圧縮アルゴリズムの配列を返す
Phar::getSupportedSignatures — サポートするシグネチャ型の配列を返す
Phar::getVersion — Phar アーカイブのバージョン情報を返す
Phar::hasMetaData — ファイルがグローバルなメタデータを持つかどうかを返す
Phar::interceptFileFuncs — fopen、file_get_contents、opendir などの stat 関連の関数をすべて phar に横取りさせる
Phar::isBuffering — Phar の書き込み操作がバッファリングされるか、あるいは直接ディスクに書き込まれるかを調べる
Phar::isCompressed — phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す
Phar::isFileFormat — phar アーカイブが、パラメータで指定した tar/phar/zip のいずれかの形式である場合に true を返す
Phar::isValidPharFilename — 指定したファイル名が正しい形式の phar ファイルかどうかを返す
Phar::isWritable — phar アーカイブが変更可能な場合に true を返す
Phar::loadPhar — 任意の phar アーカイブを、エイリアスを指定して読み込む
Phar::mapPhar — 現在実行されている (phar 形式の) ファイルを読み込み、その内容を登録する
Phar::mount — 外部のパスあるいはファイルを phar アーカイブ内に仮想的にマウントする
Phar::mungServer — 最大 4 つまでの $_SERVER 変数を実行時に変更させる
Phar::offsetExists — ファイルが phar 内に存在するかどうかを調べる
Phar::offsetGet — 指定したファイルの PharFileInfo オブジェクトを取得する
Phar::offsetSet — 内部ファイルに、外部ファイルの内容を設定する
Phar::offsetUnset — ファイルを phar から削除する
Phar::running — 現在実行中の Phar アーカイブのフルパスあるいは完全な phar URL を返す
Phar::setAlias — Phar アーカイブのエイリアスを設定する
Phar::setDefaultStub — Phar アーカイブの PHP ローダー (起動スタブ) をデフォルトのローダーに設定する
Phar::setMetadata — phar アーカイブのメタデータを設定する
Phar::setSignatureAlgorithm — phar のシグネチャのアルゴリズムを設定して適用する
Phar::setStub — Phar アーカイブの PHP ローダ (あるいは起動スタブ) を設定する
Phar::startBuffering — Phar の書き込み操作のバッファリングを開始するが、ディスク上の Phar オブジェクトは変更しない
Phar::stopBuffering — Phar アーカイブへの書き込みリクエストのバッファリングを終了し、変更内容をディスクに書き込む
Phar::uncompressAllFiles — 現在の Phar アーカイブ内のすべてのファイルを展開する
Phar::unlinkArchive — phar アーカイブをディスクとメモリから完全に削除する
Phar::webPhar — ウェブベースの phar で使用するフロントコントローラ
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 では使用不能)
PharFileInfo::chmod — ファイル固有のパーミッションビットを設定する
PharFileInfo::compress — 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する
PharFileInfo::__construct — Phar エントリオブジェクトを作成する
PharFileInfo::decompress — phar 内の現在の Phar エントリの圧縮を解除する
PharFileInfo::delMetadata — エントリのメタデータを削除する
PharFileInfo::getCRC32 — CRC32 コードを返すか、CRC がチェックできない場合に例外をスローする
PharFileInfo::getCompressedSize — Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す
PharFileInfo::getMetaData — ファイルとともに保存されている、ファイル固有のメタデータを返す
PharFileInfo::getPharFlags — Phar ファイルエントリのフラグを返す
PharFileInfo::hasMetadata — エントリのメタデータを返す
PharFileInfo::isCRCChecked — ファイルエントリの CRC が検証されているかどうかを調べる
PharFileInfo::isCompressed — エントリが圧縮されているかどうかを調べる
PharFileInfo::isCompressedBZIP2 — エントリが bzip2 で圧縮されているかどうかを調べる
PharFileInfo::isCompressedGZ — エントリが gz で圧縮されているかどうかを調べる
PharFileInfo::setCompressedBZIP2 — phar 内の現在の Phar エントリを、Bzip2 で圧縮する
PharFileInfo::setCompressedGZ — phar 内の現在の Phar エントリを、gz で圧縮する
PharFileInfo::setMetaData — ファイルとともに保存する、ファイル固有のメタデータを設定する
PharFileInfo::setUncompressed — phar 内の現在の Phar エントリが圧縮されている場合に、それを展開する
PharException — PharException クラスは、try/catch ブロックで使用するための phar 固有の例外クラスです

add a note User Contributed Notes
Phar

There are no user contributed notes for this page.

導入

lzf_optimized_for

Last updated: Fri, 29 Aug 2008