The PharData class

The PharData class

Introduction

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

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.

Class synopsis

class PharData extends RecursiveDirectoryIterator implements Countable, ArrayAccess {

/* Inherited constants */

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;

/* Methods */

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

}

Table of Contents

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

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.phardata.php