path: root/ext/phar/phar_object.stub.php

<?php

/** @generate-function-entries */

class PharException extends Exception
{
}

class Phar extends RecursiveDirectoryIterator implements Countable, ArrayAccess
{
    public function __construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS|FilesystemIterator::UNIX_PATHS, ?string $alias = null) {}

    public function __destruct() {}

    /** @return void */
    public function addEmptyDir(string $directory) {}

    /** @return void */
    public function addFile(string $filename, ?string $localName = null) {}

    /** @return void */
    public function addFromString(string $localName, string $contents) {}

    /** @return array|false */
    public function buildFromDirectory(string $directory, string $pattern = "") {}

    /** @return array|false */
    public function buildFromIterator(Traversable $iterator, ?string $baseDirectory = null) {}

    /** @return void */
    public function compressFiles(int $compression) {}

    /** @return bool */
    public function decompressFiles() {}

    /** @return Phar|null */
    public function compress(int $compression, ?string $extension = null) {}

    /** @return Phar|null */
    public function decompress(?string $extension = null) {}

    /** @return Phar|null */
    public function convertToExecutable(?int $format = null, ?int $compression = null, ?string $extension = null) {}

    /** @return Phar|null */
    public function convertToData(?int $format = null, ?int $compression = null, ?string $extension = null) {}

    /** @return bool */
    public function copy(string $to, string $from) {}

    /** @return int */
    public function count(int $mode = COUNT_NORMAL) {}

    /** @return bool */
    public function delete(string $localName) {}

    /** @return bool */
    public function delMetadata() {}

    /** @return bool */
    public function extractTo(string $directory, array|string|null $files = null, bool $overwrite = false) {}

    /** @return string|null */
    public function getAlias() {}

    /** @return string */
    public function getPath() {}

    /** @return mixed */
    public function getMetadata(array $unserializeOptions = []) {}

    /** @return bool */
    public function getModified() {}

    /** @return array|false */
    public function getSignature() {}

    /** @return string */
    public function getStub() {}

    /** @return string */
    public function getVersion() {}

    /** @return bool */
    public function hasMetadata() {}

    /** @return bool */
    public function isBuffering() {}

    /** @return int|false */
    public function isCompressed() {}

    /** @return bool */
    public function isFileFormat(int $format) {}

    /** @return bool */
    public function isWritable() {}

    /**
     * @param string $localName
     * @return bool
     */
    public function offsetExists($localName) {}

    /**
     * @param string $localName
     * @return PharFileInfo
     */
    public function offsetGet($localName) {}

    /**
     * @param string $localName
     * @param resource|string $value
     * @return void
     */
    public function offsetSet($localName, $value) {}

    /**
     * @param string $localName
     * @return bool
     */
    public function offsetUnset($localName) {}

    /** @return bool */
    public function setAlias(string $alias) {}

    /** @return bool */
    public function setDefaultStub(?string $index = null, ?string $webIndex = null) {}

    /** @return void */
    public function setMetadata(mixed $metadata) {}

    /** @return void */
    public function setSignatureAlgorithm(int $algo, ?string $privateKey = null) {}

    /**
     * @param resource|string $stub
     * @return bool
     */
    public function setStub($stub, int $length = UNKNOWN) {}

    /** @return void */
    public function startBuffering() {}

    /** @return void */
    public function stopBuffering() {}

    final public static function apiVersion(): string {}

    final public static function canCompress(int $compression = 0): bool {}

    final public static function canWrite(): bool {}

    final public static function createDefaultStub(?string $index = null, ?string $webIndex = null): string {}

    final public static function getSupportedCompression(): array {}

    final public static function getSupportedSignatures(): array {}

    final public static function interceptFileFuncs(): void {}

    final public static function isValidPharFilename(string $filename, bool $executable = true): bool {}

    final public static function loadPhar(string $filename, ?string $alias = null): bool {}

    final public static function mapPhar(?string $alias = null, int $offset = 0): bool {}

    final public static function running(bool $returnPhar = true): string {}

    final public static function mount(string $pharPath, string $externalPath): void {}

    final public static function mungServer(array $variables): void {}

    final public static function unlinkArchive(string $filename): bool {}

    final public static function webPhar(
        ?string $alias = null, ?string $index = null, ?string $fileNotFoundScript = null,
        array $mimeTypes = [], ?callable $rewrite = null): void {}
}

class PharData extends RecursiveDirectoryIterator implements Countable, ArrayAccess
{
    /** @implementation-alias Phar::__construct */
    public function __construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS|FilesystemIterator::UNIX_PATHS, ?string $alias = null, int $format = 0) {}

    /** @implementation-alias Phar::__destruct */
    public function __destruct() {}

    /**
     * @return void
     * @implementation-alias Phar::addEmptyDir
     */
    public function addEmptyDir(string $directory) {}

    /**
     * @return void
     * @implementation-alias Phar::addFile
     */
    public function addFile(string $filename, ?string $localName = null) {}

    /**
     * @return void
     * @implementation-alias Phar::addFromString
     */
    public function addFromString(string $localName, string $contents) {}

    /**
     * @return array|false
     * @implementation-alias Phar::buildFromDirectory
     */
    public function buildFromDirectory(string $directory, string $pattern = "") {}

    /**
     * @return array|false
     * @implementation-alias Phar::buildFromIterator
     */
    public function buildFromIterator(Traversable $iterator, ?string $baseDirectory = null) {}

    /**
     * @return void
     * @implementation-alias Phar::compressFiles
     */
    public function compressFiles(int $compression) {}

    /**
     * @return bool
     * @implementation-alias Phar::decompressFiles
     */
    public function decompressFiles() {}

    /**
     * @return Phar|null
     * @implementation-alias Phar::compress
     */
    public function compress(int $compression, ?string $extension = null) {}

    /**
     * @return Phar|null
     * @implementation-alias Phar::decompress
     */
    public function decompress(?string $extension = null) {}

    /**
     * @return Phar|null
     * @implementation-alias Phar::convertToExecutable
     */
    public function convertToExecutable(?int $format = null, ?int $compression = null, ?string $extension = null) {}

    /**
     * @return Phar|null
     * @implementation-alias Phar::convertToData
     */
    public function convertToData(?int $format = null, ?int $compression = null, ?string $extension = null) {}

    /**
     * @return bool
     * @implementation-alias Phar::copy
     */
    public function copy(string $to, string $from) {}

    /**
     * @return int
     * @implementation-alias Phar::count
     */
    public function count(int $mode = COUNT_NORMAL) {}

    /**
     * @return bool
     * @implementation-alias Phar::delete
     */
    public function delete(string $localName) {}

    /**
     * @return bool
     * @implementation-alias Phar::delMetadata
     */
    public function delMetadata() {}

    /**
     * @return bool
     * @implementation-alias Phar::extractTo
     */
    public function extractTo(string $directory, array|string|null $files = null, bool $overwrite = false) {}

    /**
     * @return string|null
     * @implementation-alias Phar::getAlias
     */
    public function getAlias() {}

    /**
     * @return string
     * @implementation-alias Phar::getPath
     */
    public function getPath() {}

    /**
     * @return mixed
     * @implementation-alias Phar::getMetadata
     */
    public function getMetadata(array $unserializeOptions = []) {}

    /**
     * @return bool
     * @implementation-alias Phar::getModified
     */
    public function getModified() {}

    /**
     * @return array|false
     * @implementation-alias Phar::getSignature
     */
    public function getSignature() {}

    /**
     * @return string
     * @implementation-alias Phar::getStub
     */
    public function getStub() {}

    /**
     * @return string
     * @implementation-alias Phar::getVersion
     */
    public function getVersion() {}

    /**
     * @return bool
     * @implementation-alias Phar::hasMetadata
     */
    public function hasMetadata() {}

    /**
     * @return bool
     * @implementation-alias Phar::isBuffering
     */
    public function isBuffering() {}

    /**
     * @return int|false
     * @implementation-alias Phar::isCompressed
     */
    public function isCompressed() {}

    /**
     * @return bool
     * @implementation-alias Phar::isFileFormat
     */
    public function isFileFormat(int $format) {}

    /**
     * @return bool
     * @implementation-alias Phar::isWritable
     */
    public function isWritable() {}

    /**
     * @param string $localName
     * @return bool
     * @implementation-alias Phar::offsetExists
     */
    public function offsetExists($localName) {}

    /**
     * @param string $localName
     * @return PharFileInfo
     * @implementation-alias Phar::offsetGet
     */
    public function offsetGet($localName) {}

    /**
     * @param string $localName
     * @param resource|string $value
     * @return void
     * @implementation-alias Phar::offsetSet
     */
    public function offsetSet($localName, $value) {}

    /**
     * @param string $localName
     * @return bool
     * @implementation-alias Phar::offsetUnset
     */
    public function offsetUnset($localName) {}

    /**
     * @return bool
     * @implementation-alias Phar::setAlias
     */
    public function setAlias(string $alias) {}

    /**
     * @return bool
     * @implementation-alias Phar::setDefaultStub
     */
    public function setDefaultStub(?string $index = null, ?string $webIndex = null) {}

    /**
     * @return void
     * @implementation-alias Phar::setMetadata
     */
    public function setMetadata(mixed $metadata) {}

    /**
     * @return void
     * @implementation-alias Phar::setSignatureAlgorithm
     */
    public function setSignatureAlgorithm(int $algo, ?string $privateKey = null) {}

    /**
     * @param resource|string $stub
     * @return bool
     * @implementation-alias Phar::setStub
     */
    public function setStub($stub, int $length = UNKNOWN) {}

    /**
     * @return void
     * @implementation-alias Phar::startBuffering
     */
    public function startBuffering() {}

    /**
     * @return void
     * @implementation-alias Phar::stopBuffering
     */
    public function stopBuffering() {}

    /** @implementation-alias Phar::apiVersion */
    final public static function apiVersion(): string {}

    /** @implementation-alias Phar::canCompress */
    final public static function canCompress(int $compression = 0): bool {}

    /** @implementation-alias Phar::canWrite */
    final public static function canWrite(): bool {}

    /** @implementation-alias Phar::createDefaultStub */
    final public static function createDefaultStub(?string $index = null, ?string $webIndex = null): string {}

    /** @implementation-alias Phar::getSupportedCompression */
    final public static function getSupportedCompression(): array {}

    /** @implementation-alias Phar::getSupportedSignatures */
    final public static function getSupportedSignatures(): array {}

    /** @implementation-alias Phar::interceptFileFuncs */
    final public static function interceptFileFuncs(): void {}

    /** @implementation-alias Phar::isValidPharFilename */
    final public static function isValidPharFilename(string $filename, bool $executable = true): bool {}

    /** @implementation-alias Phar::loadPhar */
    final public static function loadPhar(string $filename, ?string $alias = null): bool {}

    /** @implementation-alias Phar::mapPhar */
    final public static function mapPhar(?string $alias = null, int $offset = 0): bool {}

    /** @implementation-alias Phar::running */
    final public static function running(bool $returnPhar = true): string {}

    /** @implementation-alias Phar::mount */
    final public static function mount(string $pharPath, string $externalPath): void {}

    /** @implementation-alias Phar::mungServer */
    final public static function mungServer(array $variables): void {}

    /** @implementation-alias Phar::unlinkArchive */
    final public static function unlinkArchive(string $filename): bool {}

    /** @implementation-alias Phar::webPhar */
    final public static function webPhar(
        ?string $alias = null, ?string $index = null, ?string $fileNotFoundScript = null,
        array $mimeTypes = [], ?callable $rewrite = null): void {}
}

class PharFileInfo extends SplFileInfo
{
    public function __construct(string $filename) {}

    public function __destruct() {}

    /** @return void */
    public function chmod(int $perms) {}

    /** @return bool */
    public function compress(int $compression) {}

    /** @return bool */
    public function decompress() {}

    /** @return bool */
    public function delMetadata() {}

    /** @return int */
    public function getCompressedSize() {}

    /** @return int */
    public function getCRC32() {}

    /** @return string */
    public function getContent() {}

    /** @return mixed */
    public function getMetadata(array $unserializeOptions = []) {}

    /** @return int */
    public function getPharFlags() {}

    /** @return bool */
    public function hasMetadata() {}

    /** @return bool */
    public function isCompressed(?int $compression = null) {}

    /** @return bool */
    public function isCRCChecked() {}

    /** @return void */
    public function setMetadata(mixed $metadata) {}
}