Phar クラス

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

はじめに

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

クラス概要

constintBZ2;
constintGZ;
constintNONE;
constintPHAR;
constintTAR;
constintZIP;
constintPHP;
constintPHPS;
constintMD5;
constintSHA1;
constintSHA256;
constintSHA512;
public__construct(string$filename, int$flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string$alias = null)
publicaddEmptyDir(string$directory): void
publicaddFile(string$filename, ?string$localName = null): void
publicaddFromString(string$localName, string$contents): void
finalpublicstaticapiVersion(): string
publicbuildFromDirectory(string$directory, string$pattern = ""): array
publicbuildFromIterator(Traversable$iterator, ?string$baseDirectory = null): array
finalpublicstaticcanCompress(int$compression = 0): bool
finalpublicstaticcanWrite(): bool
publiccompress(int$compression, ?string$extension = null): ?Phar
publiccompressFiles(int$compression): void
publicconvertToData(?int$format = null, ?int$compression = null, ?string$extension = null): ?PharData
publicconvertToExecutable(?int$format = null, ?int$compression = null, ?string$extension = null): ?Phar
publiccopy(string$from, string$to): bool
publiccount(int$mode = COUNT_NORMAL): int
finalpublicstaticcreateDefaultStub(?string$index = null, ?string$webIndex = null): string
publicdecompress(?string$extension = null): ?Phar
publicdelMetadata(): bool
publicdelete(string$localName): bool
publicextractTo(string$directory, array|string|null$files = null, bool$overwrite = false): bool
publicgetAlias(): ?string
publicgetMetadata(array$unserializeOptions = []): mixed
publicgetModified(): bool
publicgetPath(): string
publicgetStub(): string
finalpublicstaticgetSupportedCompression(): array
finalpublicstaticgetSupportedSignatures(): array
publichasMetadata(): bool
finalpublicstaticinterceptFileFuncs(): void
publicisBuffering(): bool
publicisFileFormat(int$format): bool
finalpublicstaticisValidPharFilename(string$filename, bool$executable = true): bool
publicisWritable(): bool
finalpublicstaticloadPhar(string$filename, ?string$alias = null): bool
finalpublicstaticmapPhar(?string$alias = null, int$offset = 0): bool
finalpublicstaticmount(string$pharPath, string$externalPath): void
finalpublicstaticmungServer(array$variables): void
publicoffsetExists(string$localName): bool
publicoffsetGet(string$localName): SplFileInfo
publicoffsetSet(string$localName, resource|string$value): void
publicoffsetUnset(string$localName): void
finalpublicstaticrunning(bool$returnPhar = true): string
publicsetAlias(string$alias): bool
publicsetDefaultStub(?string$index = null, ?string$webIndex = null): bool
publicsetMetadata(mixed$metadata): void
publicsetSignatureAlgorithm(int$algo, ?string$privateKey = null): void
publicsetStub(resource|string$stub, int$length = -1): bool
finalpublicstaticunlinkArchive(string$filename): bool
finalpublicstaticwebPhar(
    ?string$alias = null,
    ?string$index = null,
    ?string$fileNotFoundScript = null,
    array$mimeTypes = [],
    ?callable$rewrite = null
): void
public__destruct()
publicSplFileInfo::openFile(string$mode = "r", bool$useIncludePath = false, ?resource$context = null): SplFileObject
publicSplFileInfo::setFileClass(string$class = SplFileObject::class): void
publicSplFileInfo::setInfoClass(string$class = SplFileInfo::class): void
}

目次

  • 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::compressFiles — 現在の Phar アーカイブ内のすべてのファイルを圧縮する
  • Phar::__construct — Phar アーカイブオブジェクトを作成する
  • Phar::convertToData — phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する
  • Phar::convertToExecutable — phar アーカイブを実行可能な別の phar アーカイブ形式に変換する
  • Phar::copy — phar アーカイブ内のファイルを、phar 内で別の新しいファイルとしてコピーする
  • Phar::count — Phar アーカイブ内のエントリ (ファイル) の数を返す
  • Phar::createDefaultStub — phar ファイルフォーマット用のスタブを作成する
  • Phar::decompress — Phar アーカイブ全体の圧縮を解除する
  • Phar::decompressFiles — 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
  • Phar::delMetadata — phar のグローバルメタデータを削除する
  • Phar::delete — phar アーカイブ内のファイルを削除する
  • Phar::__destruct — アクティブな Phar オブジェクトを破棄する
  • Phar::extractTo — phar アーカイブの内容をディレクトリに展開する
  • Phar::getAlias — Phar のエイリアスを取得する
  • Phar::getMetadata — phar アーカイブのメタデータを返す
  • Phar::getModified — phar が変更されているかどうかを返す
  • Phar::getPath — Pharアーカイブのディスク上の実際のパスを取得する
  • Phar::getSignature — Phar アーカイブの MD5/SHA1/SHA256/SHA512/OpenSSL シグネチャを返す
  • 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::unlinkArchive — phar アーカイブをディスクとメモリから完全に削除する
  • Phar::webPhar — ブラウザからのリクエストを、phar アーカイブ内部のファイルに転送する
To Top