PHP Manual
Phar
The PharData class

The PharData class

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

Einführung

The PharData class provides a high-level interface to accessing and creating non-executable tar and zip archives. Because these archives do not contain a stub and cannot be executed by the phar extension, it is possible to create and manipulate regular zip and tar files using the PharData class even if phar.readonly php.ini setting is 1.

Klassenbeschreibung

class PharData extends RecursiveDirectoryIterator implements Countable, ArrayAccess {

/* Geerbte Konstanten */

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;

/* Methoden */

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

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

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

public compressFiles(int $compression): void

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

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

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

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

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

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

public __destruct()

/* Geerbte Methoden */

public RecursiveDirectoryIterator::getChildren(): RecursiveDirectoryIterator

public RecursiveDirectoryIterator::getSubPath(): string

public RecursiveDirectoryIterator::getSubPathname(): string

public RecursiveDirectoryIterator::hasChildren(bool $allowLinks = false): bool

public RecursiveDirectoryIterator::key(): string

public RecursiveDirectoryIterator::next(): void

public RecursiveDirectoryIterator::rewind(): void

public FilesystemIterator::current(): string|SplFileInfo|FilesystemIterator

public FilesystemIterator::getFlags(): int

public FilesystemIterator::key(): string

public FilesystemIterator::next(): void

public FilesystemIterator::rewind(): void

public FilesystemIterator::setFlags(int $flags): void

public DirectoryIterator::current(): mixed

public DirectoryIterator::getATime(): int

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

public DirectoryIterator::getCTime(): int

public DirectoryIterator::getExtension(): string

public DirectoryIterator::getFilename(): string

public DirectoryIterator::getGroup(): int

public DirectoryIterator::getInode(): int

public DirectoryIterator::getMTime(): int

public DirectoryIterator::getOwner(): int

public DirectoryIterator::getPath(): string

public DirectoryIterator::getPathname(): string

public DirectoryIterator::getPerms(): int

public DirectoryIterator::getSize(): int

public DirectoryIterator::getType(): string

public DirectoryIterator::isDir(): bool

public DirectoryIterator::isDot(): bool

public DirectoryIterator::isExecutable(): bool

public DirectoryIterator::isFile(): bool

public DirectoryIterator::isLink(): bool

public DirectoryIterator::isReadable(): bool

public DirectoryIterator::isWritable(): bool

public DirectoryIterator::key(): mixed

public DirectoryIterator::next(): void

public DirectoryIterator::rewind(): void

public DirectoryIterator::seek(int $offset): void

public DirectoryIterator::__toString(): string

public DirectoryIterator::valid(): bool

public SplFileInfo::getATime(): int|false

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

public SplFileInfo::getCTime(): int|false

public SplFileInfo::getExtension(): string

public SplFileInfo::getFileInfo(?string $class = null): SplFileInfo

public SplFileInfo::getFilename(): string

public SplFileInfo::getGroup(): int|false

public SplFileInfo::getInode(): int|false

public SplFileInfo::getLinkTarget(): string|false

public SplFileInfo::getMTime(): int|false

public SplFileInfo::getOwner(): int|false

public SplFileInfo::getPath(): string

public SplFileInfo::getPathInfo(?string $class = null): ?SplFileInfo

public SplFileInfo::getPathname(): string

public SplFileInfo::getPerms(): int|false

public SplFileInfo::getRealPath(): string|false

public SplFileInfo::getSize(): int|false

public SplFileInfo::getType(): string|false

public SplFileInfo::isDir(): bool

public SplFileInfo::isExecutable(): bool

public SplFileInfo::isFile(): bool

public SplFileInfo::isLink(): bool

public SplFileInfo::isReadable(): bool

public SplFileInfo::isWritable(): bool

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

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

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

public SplFileInfo::__toString(): string

}

Inhaltsverzeichnis

PharData::addEmptyDir — Add an empty directory to the tar/zip archive
PharData::addFile — Add a file from the filesystem to the tar/zip archive
PharData::addFromString — Add a file from the filesystem to the tar/zip archive
PharData::buildFromDirectory — Construct a tar/zip archive from the files within a directory
PharData::buildFromIterator — Construct a tar or zip archive from an iterator
PharData::compress — Compresses the entire tar/zip archive using Gzip or Bzip2 compression
PharData::compressFiles — Compresses all files in the current tar/zip archive
PharData::__construct — Construct a non-executable tar or zip archive object
PharData::convertToData — Convert a phar archive to a non-executable tar or zip file
PharData::convertToExecutable — Convert a non-executable tar/zip archive to an executable phar archive
PharData::copy — Copy a file internal to the phar archive to another new file within the phar
PharData::decompress — Decompresses the entire Phar archive
PharData::decompressFiles — Decompresses all files in the current zip archive
PharData::delMetadata — Deletes the global metadata of a zip archive
PharData::delete — Delete a file within a tar/zip archive
PharData::__destruct — Destructs a non-executable tar or zip archive object
PharData::extractTo — Extract the contents of a tar/zip archive to a directory
PharData::isWritable — Returns true if the tar/zip archive can be modified
PharData::offsetSet — Set the contents of a file within the tar/zip to those of an external file or string
PharData::offsetUnset — Remove a file from a tar/zip archive
PharData::setAlias — Dummy function (Phar::setAlias is not valid for PharData)
PharData::setDefaultStub — Dummy function (Phar::setDefaultStub is not valid for PharData)
PharData::setMetadata — Sets phar archive meta-data
PharData::setSignatureAlgorithm — Set the signature algorithm for a phar and apply it
PharData::setStub — Dummy function (Phar::setStub is not valid for PharData)