Phar

目次

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()

PharData クラス

はじめに

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

クラス概要

PharData
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;
/* メソッド */
public PharData::__construct(
    string $filename,
    int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS,
    stringnull $alias = null,
    int $format = 0
)
public void PharData::addEmptyDir(string $directory)
public void PharData::addFile(string $filename, stringnull $localName = null)
public void PharData::addFromString(string $localName, string $contents)
public array PharData::buildFromDirectory(string $directory, string $pattern = "")
public array PharData::buildFromIterator(Traversable $iterator, stringnull $baseDirectory = null)
public PharDatanull PharData::compress(int $compression, stringnull $extension = null)
public void PharData::compressFiles(int $compression)
public PharDatanull PharData::convertToData(intnull $format = null, intnull $compression = null, stringnull $extension = null)
public Pharnull PharData::convertToExecutable(intnull $format = null, intnull $compression = null, stringnull $extension = null)
public bool PharData::copy(string $from, string $to)
public PharDatanull PharData::decompress(stringnull $extension = null)
public bool PharData::decompressFiles()
public bool PharData::delMetadata()
public bool PharData::delete(string $localName)
public bool PharData::extractTo(string $directory, arraystringnull $files = null, bool $overwrite = false)
public bool PharData::isWritable()
public void PharData::offsetSet(string $localName, resourcestring $value)
public void PharData::offsetUnset(string $localName)
public bool PharData::setAlias(string $alias)
public bool PharData::setDefaultStub(stringnull $index = null, stringnull $webIndex = null)
public void PharData::setMetadata(mixed $metadata)
public void PharData::setSignatureAlgorithm(int $algo, stringnull $privateKey = null)
public bool PharData::setStub(string $stub, int $len = -1)
public PharData::__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()

PharFileInfo クラス

はじめに

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

クラス概要

PharFileInfo
extends SplFileInfo
/* メソッド */
public PharFileInfo::__construct(string $filename)
public void PharFileInfo::chmod(int $perms)
public bool PharFileInfo::compress(int $compression)
public bool PharFileInfo::decompress()
public bool PharFileInfo::delMetadata()
public int PharFileInfo::getCRC32()
public int PharFileInfo::getCompressedSize()
public string PharFileInfo::getContent()
public mixed PharFileInfo::getMetadata(array $unserializeOptions = [])
public int PharFileInfo::getPharFlags()
public bool PharFileInfo::hasMetadata()
public bool PharFileInfo::isCRCChecked()
public bool PharFileInfo::isCompressed(intnull $compression = null)
public void PharFileInfo::setMetadata(mixed $metadata)
public PharFileInfo::__destruct()
/* 継承したメソッド */
public intfalse getATime()
public string getBasename(string $suffix = "")
public intfalse getCTime()
public string getExtension()
public SplFileInfo getFileInfo(stringnull $class = null)
public string getFilename()
public intfalse getGroup()
public intfalse getInode()
public stringfalse getLinkTarget()
public intfalse getMTime()
public intfalse getOwner()
public string getPath()
public SplFileInfonull getPathInfo(stringnull $class = null)
public string getPathname()
public intfalse getPerms()
public stringfalse getRealPath()
public intfalse getSize()
public stringfalse getType()
public bool isDir()
public bool isExecutable()
public bool isFile()
public bool isLink()
public bool isReadable()
public bool isWritable()
public SplFileObject openFile(string $mode = "r", bool $useIncludePath = false, resourcenull $context = null)
public void setFileClass(string $class = SplFileObject::class)
public void setInfoClass(string $class = SplFileInfo::class)
public string __toString()

PharException クラス

はじめに

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

クラス概要

PharException
extends Exception
/* 継承したプロパティ */
protected string $message = "";
private string $string = "";
protected int $code;
protected string $file = "";
protected int $line;
private array $trace = [];
private Throwablenull $previous = null;
/* 継承したメソッド */
public __construct(string $message = "", int $code = 0, Throwablenull $previous = null)
final public string getMessage()
final public Throwablenull getPrevious()
final public int getCode()
final public string getFile()
final public int getLine()
final public array getTrace()
final public string getTraceAsString()
public string __toString()
private void __clone()