PharData クラス

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

はじめに

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

クラス概要

class PharData extends RecursiveDirectoryIterator implements Countable, ArrayAccess {

/* 継承した定数 */

const int FilesystemIterator::CURRENT_AS_PATHNAME = 32;

const int FilesystemIterator::CURRENT_AS_FILEINFO = 0;

const int FilesystemIterator::CURRENT_AS_SELF = 16;

const int FilesystemIterator::CURRENT_MODE_MASK = 240;

const int FilesystemIterator::KEY_AS_PATHNAME = 0;

const int FilesystemIterator::KEY_AS_FILENAME = 256;

const int FilesystemIterator::FOLLOW_SYMLINKS = 512;

const int FilesystemIterator::KEY_MODE_MASK = 3840;

const int FilesystemIterator::NEW_CURRENT_AND_KEY = 256;

const int FilesystemIterator::SKIP_DOTS = 4096;

const int FilesystemIterator::UNIX_PATHS = 8192;

/* メソッド */

public __construct(
    string $filename,
    int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS,
    ?string $alias = null,
    int $format = 0
)

public addEmptyDir(string $directory): void

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

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

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

public buildFromIterator(Traversable $iterator, ?string $baseDirectory = null): array|false

public compress(int $compression, ?string $extension = null): ?Phar

public compressFiles(int $compression): void

public convertToData(?int $format = null, ?int $compression = null, ?string $extension = null): ?Phar

public convertToExecutable(?int $format = null, ?int $compression = null, ?string $extension = null): ?Phar

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

public decompress(?string $extension = null): ?Phar

public decompressFiles(): bool

public delMetadata(): bool

public delete(string $localName): bool

public extractTo(string $directory, array|string|null $files = null, bool $overwrite = false): bool

public isWritable(): bool

public offsetSet(string $localName, resource|string $value): void

public offsetUnset(string $localName): bool

public setAlias(string $alias): bool

public setDefaultStub(?string $index = null, ?string $webIndex = null): bool

public setMetadata(mixed $metadata): void

public setSignatureAlgorithm(int $algo, ?string $privateKey = null): void

public setStub(string $stub, int $len = -1): bool

}

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 では無効)
PharData::setMetadata — phar アーカイブのメタデータを設定する
PharData::setSignatureAlgorithm — phar のシグネチャのアルゴリズムを設定する
PharData::setStub — ダミー関数 (Phar::setStub は PharData では使用不能)

add a note

User Contributed Notes

There are no user contributed notes for this page.

PharData クラス

はじめに

クラス概要

目次

User Contributed Notes