Phar クラス

はじめに

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

クラス概要

Phar

extends RecursiveDirectoryIterator

implements Countable ArrayAccess

/* 継承した定数 */

public const int FilesystemIterator::CURRENT_MODE_MASK;

public const int FilesystemIterator::CURRENT_AS_PATHNAME;

public const int FilesystemIterator::CURRENT_AS_FILEINFO;

public const int FilesystemIterator::CURRENT_AS_SELF;

public const int FilesystemIterator::KEY_MODE_MASK;

public const int FilesystemIterator::KEY_AS_PATHNAME;

public const int FilesystemIterator::FOLLOW_SYMLINKS;

public const int FilesystemIterator::KEY_AS_FILENAME;

public const int FilesystemIterator::NEW_CURRENT_AND_KEY;

public const int FilesystemIterator::OTHER_MODE_MASK;

public const int FilesystemIterator::SKIP_DOTS;

public const int FilesystemIterator::UNIX_PATHS;

/* 定数 */

const int Phar::BZ2;

const int Phar::GZ;

const int Phar::NONE;

const int Phar::PHAR;

const int Phar::TAR;

const int Phar::ZIP;

const int Phar::COMPRESSED;

const int Phar::PHP;

const int Phar::PHPS;

const int Phar::MD5;

const int Phar::OPENSSL;

const int Phar::OPENSSL_SHA256;

const int Phar::OPENSSL_SHA512;

const int Phar::SHA1;

const int Phar::SHA256;

const int Phar::SHA512;

/* メソッド */

public Phar::__construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, stringnull $alias = null)

public void Phar::addEmptyDir(string $directory)

public void Phar::addFile(string $filename, stringnull $localName = null)

public void Phar::addFromString(string $localName, string $contents)

final public static string Phar::apiVersion()

public array Phar::buildFromDirectory(string $directory, string $pattern = "")

public array Phar::buildFromIterator(Traversable $iterator, stringnull $baseDirectory = null)

final public static bool Phar::canCompress(int $compression = 0)

final public static bool Phar::canWrite()

public Pharnull Phar::compress(int $compression, stringnull $extension = null)

public void Phar::compressFiles(int $compression)

public PharDatanull Phar::convertToData(intnull $format = null, intnull $compression = null, stringnull $extension = null)

public Pharnull Phar::convertToExecutable(intnull $format = null, intnull $compression = null, stringnull $extension = null)

public bool Phar::copy(string $from, string $to)

public int Phar::count(int $mode = COUNT_NORMAL)

final public static string Phar::createDefaultStub(stringnull $index = null, stringnull $webIndex = null)

public Pharnull Phar::decompress(stringnull $extension = null)

public bool Phar::decompressFiles()

public bool Phar::delMetadata()

public bool Phar::delete(string $localName)

public bool Phar::extractTo(string $directory, arraystringnull $files = null, bool $overwrite = false)

public stringnull Phar::getAlias()

public mixed Phar::getMetadata(array $unserializeOptions = [])

public bool Phar::getModified()

public string Phar::getPath()

public arrayfalse Phar::getSignature()

public string Phar::getStub()

final public static array Phar::getSupportedCompression()

final public static array Phar::getSupportedSignatures()

public string Phar::getVersion()

public bool Phar::hasMetadata()

final public static void Phar::interceptFileFuncs()

public bool Phar::isBuffering()

public intfalse Phar::isCompressed()

public bool Phar::isFileFormat(int $format)

final public static bool Phar::isValidPharFilename(string $filename, bool $executable = true)

public bool Phar::isWritable()

final public static bool Phar::loadPhar(string $filename, stringnull $alias = null)

final public static bool Phar::mapPhar(stringnull $alias = null, int $offset = 0)

final public static void Phar::mount(string $pharPath, string $externalPath)

final public static void Phar::mungServer(array $variables)

public bool Phar::offsetExists(string $localName)

public SplFileInfo Phar::offsetGet(string $localName)

public void Phar::offsetSet(string $localName, resourcestring $value)

public void Phar::offsetUnset(string $localName)

final public static string Phar::running(bool $returnPhar = true)

public bool Phar::setAlias(string $alias)

public bool Phar::setDefaultStub(stringnull $index = null, stringnull $webIndex = null)

public void Phar::setMetadata(mixed $metadata)

public void Phar::setSignatureAlgorithm(int $algo, stringnull $privateKey = null)

public bool Phar::setStub(resourcestring $stub, int $length = -1)

public void Phar::startBuffering()

public void Phar::stopBuffering()

final public static bool Phar::unlinkArchive(string $filename)

final public static void Phar::webPhar(
    stringnull $alias = null,
    stringnull $index = null,
    stringnull $fileNotFoundScript = null,
    array $mimeTypes = [],
    callablenull $rewrite = null
)

public Phar::__destruct()

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

public RecursiveDirectoryIterator getChildren()

public string getSubPath()

public string getSubPathname()

public bool hasChildren(bool $allowLinks = false)

public string key()

public void next()

public void rewind()

public stringSplFileInfoFilesystemIterator FilesystemIterator::current()

public int FilesystemIterator::getFlags()

public string FilesystemIterator::key()

public void FilesystemIterator::next()

public void FilesystemIterator::rewind()

public void FilesystemIterator::setFlags(int $flags)

public mixed DirectoryIterator::current()

public string DirectoryIterator::getBasename(string $suffix = "")

public string DirectoryIterator::getExtension()

public string DirectoryIterator::getFilename()

public bool DirectoryIterator::isDot()

public mixed DirectoryIterator::key()

public void DirectoryIterator::next()

public void DirectoryIterator::rewind()

public void DirectoryIterator::seek(int $offset)

public string DirectoryIterator::__toString()

public bool DirectoryIterator::valid()

public intfalse SplFileInfo::getATime()

public string SplFileInfo::getBasename(string $suffix = "")

public intfalse SplFileInfo::getCTime()

public string SplFileInfo::getExtension()

public SplFileInfo SplFileInfo::getFileInfo(stringnull $class = null)

public string SplFileInfo::getFilename()

public intfalse SplFileInfo::getGroup()

public intfalse SplFileInfo::getInode()

public stringfalse SplFileInfo::getLinkTarget()

public intfalse SplFileInfo::getMTime()

public intfalse SplFileInfo::getOwner()

public string SplFileInfo::getPath()

public SplFileInfonull SplFileInfo::getPathInfo(stringnull $class = null)

public string SplFileInfo::getPathname()

public intfalse SplFileInfo::getPerms()

public stringfalse SplFileInfo::getRealPath()

public intfalse SplFileInfo::getSize()

public stringfalse SplFileInfo::getType()

public bool SplFileInfo::isDir()

public bool SplFileInfo::isExecutable()

public bool SplFileInfo::isFile()

public bool SplFileInfo::isLink()

public bool SplFileInfo::isReadable()

public bool SplFileInfo::isWritable()

public SplFileObject SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, resourcenull $context = null)

public void SplFileInfo::setFileClass(string $class = SplFileObject::class)

public void SplFileInfo::setInfoClass(string $class = SplFileInfo::class)

public string SplFileInfo::__toString()

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 アーカイブ内部のファイルに転送する