Класс Phar

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

    Введение

    Класс Phar предоставляет высокоуровневый интерфейс для доступа и создания архивов phar.

    Обзор классов

    classPharextendsRecursiveDirectoryIteratorimplementsCountable, ArrayAccess {
    publicconstintFilesystemIterator::CURRENT_MODE_MASK;
    publicconstintFilesystemIterator::CURRENT_AS_PATHNAME;
    publicconstintFilesystemIterator::CURRENT_AS_FILEINFO;
    publicconstintFilesystemIterator::CURRENT_AS_SELF;
    publicconstintFilesystemIterator::KEY_MODE_MASK;
    publicconstintFilesystemIterator::KEY_AS_PATHNAME;
    publicconstintFilesystemIterator::FOLLOW_SYMLINKS;
    publicconstintFilesystemIterator::KEY_AS_FILENAME;
    publicconstintFilesystemIterator::NEW_CURRENT_AND_KEY;
    publicconstintFilesystemIterator::OTHER_MODE_MASK;
    publicconstintFilesystemIterator::SKIP_DOTS;
    publicconstintFilesystemIterator::UNIX_PATHS;
    constintBZ2;
    constintGZ;
    constintNONE;
    constintPHAR;
    constintTAR;
    constintZIP;
    constintCOMPRESSED;
    constintPHP;
    constintPHPS;
    constintMD5;
    constintOPENSSL;
    constintOPENSSL_SHA256;
    constintOPENSSL_SHA512;
    constintSHA1;
    constintSHA256;
    constintSHA512;
    public__construct(string$filename, int$flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string$alias = null)
    publicaddEmptyDir(string$directory): void
    publicaddFile(string$filename, ?string$localName = null): void
    publicaddFromString(string$localName, string$contents): void
    finalpublicstaticapiVersion(): string
    publicbuildFromDirectory(string$directory, string$pattern = ""): array
    publicbuildFromIterator(Traversable$iterator, ?string$baseDirectory = null): array
    finalpublicstaticcanCompress(int$compression = 0): bool
    finalpublicstaticcanWrite(): bool
    publiccompress(int$compression, ?string$extension = null): ?Phar
    publiccompressFiles(int$compression): void
    publicconvertToData(?int$format = null, ?int$compression = null, ?string$extension = null): ?PharData
    publicconvertToExecutable(?int$format = null, ?int$compression = null, ?string$extension = null): ?Phar
    publiccopy(string$from, string$to): bool
    publiccount(int$mode = COUNT_NORMAL): int
    finalpublicstaticcreateDefaultStub(?string$index = null, ?string$webIndex = null): string
    publicdecompress(?string$extension = null): ?Phar
    publicdecompressFiles(): bool
    publicdelMetadata(): bool
    publicdelete(string$localName): bool
    publicextractTo(string$directory, array|string|null$files = null, bool$overwrite = false): bool
    publicgetAlias(): ?string
    publicgetMetadata(array$unserializeOptions = []): mixed
    publicgetModified(): bool
    publicgetPath(): string
    publicgetSignature(): array|false
    publicgetStub(): string
    finalpublicstaticgetSupportedCompression(): array
    finalpublicstaticgetSupportedSignatures(): array
    publicgetVersion(): string
    publichasMetadata(): bool
    finalpublicstaticinterceptFileFuncs(): void
    publicisBuffering(): bool
    publicisCompressed(): int|false
    publicisFileFormat(int$format): bool
    finalpublicstaticisValidPharFilename(string$filename, bool$executable = true): bool
    publicisWritable(): bool
    finalpublicstaticloadPhar(string$filename, ?string$alias = null): bool
    finalpublicstaticmapPhar(?string$alias = null, int$offset = 0): bool
    finalpublicstaticmount(string$pharPath, string$externalPath): void
    finalpublicstaticmungServer(array$variables): void
    publicoffsetExists(string$localName): bool
    publicoffsetGet(string$localName): SplFileInfo
    publicoffsetSet(string$localName, resource|string$value): void
    publicoffsetUnset(string$localName): void
    finalpublicstaticrunning(bool$returnPhar = true): string
    publicsetAlias(string$alias): bool
    publicsetDefaultStub(?string$index = null, ?string$webIndex = null): bool
    publicsetMetadata(mixed$metadata): void
    publicsetSignatureAlgorithm(int$algo, ?string$privateKey = null): void
    publicsetStub(resource|string$stub, int$length = -1): bool
    publicstartBuffering(): void
    publicstopBuffering(): void
    finalpublicstaticunlinkArchive(string$filename): bool
    finalpublicstaticwebPhar(
        ?string$alias = null,
        ?string$index = null,
        ?string$fileNotFoundScript = null,
        array$mimeTypes = [],
        ?callable$rewrite = null
    ): void
    public__destruct()
    publicRecursiveDirectoryIterator::getChildren(): RecursiveDirectoryIterator
    publicRecursiveDirectoryIterator::getSubPath(): string
    publicRecursiveDirectoryIterator::getSubPathname(): string
    publicRecursiveDirectoryIterator::hasChildren(bool$allowLinks = false): bool
    publicRecursiveDirectoryIterator::key(): string
    publicRecursiveDirectoryIterator::next(): void
    publicRecursiveDirectoryIterator::rewind(): void
    publicFilesystemIterator::current(): string|SplFileInfo|FilesystemIterator
    publicFilesystemIterator::getFlags(): int
    publicFilesystemIterator::key(): string
    publicFilesystemIterator::next(): void
    publicFilesystemIterator::rewind(): void
    publicFilesystemIterator::setFlags(int$flags): void
    publicDirectoryIterator::current(): mixed
    publicDirectoryIterator::getBasename(string$suffix = ""): string
    publicDirectoryIterator::getExtension(): string
    publicDirectoryIterator::getFilename(): string
    publicDirectoryIterator::isDot(): bool
    publicDirectoryIterator::key(): mixed
    publicDirectoryIterator::next(): void
    publicDirectoryIterator::rewind(): void
    publicDirectoryIterator::seek(int$offset): void
    publicDirectoryIterator::__toString(): string
    publicDirectoryIterator::valid(): bool
    publicSplFileInfo::getATime(): int|false
    publicSplFileInfo::getBasename(string$suffix = ""): string
    publicSplFileInfo::getCTime(): int|false
    publicSplFileInfo::getExtension(): string
    publicSplFileInfo::getFileInfo(?string$class = null): SplFileInfo
    publicSplFileInfo::getFilename(): string
    publicSplFileInfo::getGroup(): int|false
    publicSplFileInfo::getInode(): int|false
    publicSplFileInfo::getLinkTarget(): string|false
    publicSplFileInfo::getMTime(): int|false
    publicSplFileInfo::getOwner(): int|false
    publicSplFileInfo::getPath(): string
    publicSplFileInfo::getPathInfo(?string$class = null): ?SplFileInfo
    publicSplFileInfo::getPathname(): string
    publicSplFileInfo::getPerms(): int|false
    publicSplFileInfo::getRealPath(): string|false
    publicSplFileInfo::getSize(): int|false
    publicSplFileInfo::getType(): string|false
    publicSplFileInfo::isDir(): bool
    publicSplFileInfo::isExecutable(): bool
    publicSplFileInfo::isFile(): bool
    publicSplFileInfo::isLink(): bool
    publicSplFileInfo::isReadable(): bool
    publicSplFileInfo::isWritable(): bool
    publicSplFileInfo::openFile(string$mode = "r", bool$useIncludePath = false, ?resource$context = null): SplFileObject
    publicSplFileInfo::setFileClass(string$class = SplFileObject::class): void
    publicSplFileInfo::setInfoClass(string$class = SplFileInfo::class): void
    publicSplFileInfo::__toString(): string
    }

    Содержание

    • Phar::addEmptyDir — Добавляет в phar-архив пустую директорию
    • Phar::addFile — Добавляет в phar-архив файл из файловой системы
    • Phar::addFromString — Добавляет в phar-архив файл из строки
    • Phar::apiVersion — Возвращает версию API
    • Phar::buildFromDirectory — Создаёт phar-архив из файлов, расположенных внутри директории
    • Phar::buildFromIterator — Создаёт phar-архив из итератора
    • Phar::canCompress — Проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2
    • Phar::canWrite — Проверяет, поддерживает ли модуль phar сохранение и создание phar-архивов
    • Phar::compress — Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия
    • Phar::compressFiles — Сжимает все файлы в текущем Phar-архиве
    • Phar::__construct — Создаёт объект Phar-архива
    • Phar::convertToData — Конвертирует phar-архив в неисполняемый tar- или zip-файл
    • Phar::convertToExecutable — Конвертирует phar-архив в другой исполняемый формат файла
    • Phar::copy — Копирует один файл внутри phar-архива в другой новый файл внутри phar-архива
    • Phar::count — Возвращает количество записей (файлов) в Phar-архиве
    • Phar::createDefaultStub — Создать заглушку в формате phar-архива
    • Phar::decompress — Распаковывает весь Phar-архив
    • Phar::decompressFiles — Распаковывает все файлы в текущем Phar-архиве
    • Phar::delMetadata — Удалить глобальные метаданные в архиве phar
    • Phar::delete — Удаляет файл внутри phar-архива
    • Phar::__destruct — Уничтожает объект архива Phar
    • Phar::extractTo — Извлечь содержимое phar-архива в директорию
    • Phar::getAlias — Получить псевдоним для Phar
    • Phar::getMetadata — Извлечь метаданные phar-архива
    • Phar::getModified — Определить, изменялся phar-архив
    • Phar::getPath — Получить реальный путь к Phar-архиву на диске
    • Phar::getSignature — Получить MD5/SHA1/SHA256/SHA512/OpenSSL подпись Phar-архива
    • Phar::getStub — Получить загрузчик PHP или загрузчик заглушки Phar-архива
    • Phar::getSupportedCompression — Возвращает массив поддерживаемых алгоритмов сжатия
    • Phar::getSupportedSignatures — Получить массив поддерживаемых алгоритмов подписи архива
    • Phar::getVersion — Получить версию Phar-архива
    • Phar::hasMetadata — Проверить, содержит ли phar-архив глобальные метаданные
    • Phar::interceptFileFuncs — Указывает phar перехватывать fopen, file_get_contents, opendir и все stat-функции
    • Phar::isBuffering — Проверить, будут ли операции с Phar-архивом буферизованы или записаны напрямую на диск
    • Phar::isCompressed — Возвращает Phar::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее)
    • Phar::isFileFormat — Проверить, что phar-архив имеет заданный формат (tar/phar/zip)
    • Phar::isValidPharFilename — Проверяет, что заданное имя файла является корректным именем phar-архива
    • Phar::isWritable — Проверяет, можно ли модифицировать phar-архив
    • Phar::loadPhar — Загрузить phar-архив с псевдонимом
    • Phar::mapPhar — Прочитать текущий запущенный phar-архив и зарегистрировать его манифест
    • Phar::mount — Монтирование внешнего путь или файла к виртуальному пути в phar-архиве
    • Phar::mungServer — Определить список до четырёх $_SERVER-переменных, которые должны быть изменены для запуска
    • Phar::offsetExists — Определить, есть ли файл в архиве
    • Phar::offsetGet — Получить объект PharFileInfo для конкретного файла
    • Phar::offsetSet — Изменение содержимого файла
    • Phar::offsetUnset — Удалить файл из phar-архива
    • Phar::running — Получить полный путь на диске, либо полный URL запущенного Phar-архива
    • Phar::setAlias — Установить псевдоним для Phar-архива
    • Phar::setDefaultStub — Установить загрузчик PHP или начальную заглушку Phar-архива в загрузчик по умолчанию
    • Phar::setMetadata — Установить метаданные phar-архива
    • Phar::setSignatureAlgorithm — Установить алгоритм подписания phar-архива и применение его
    • Phar::setStub — Установить загрузчик или загрузочную заглушку в Phar-архив
    • Phar::startBuffering — Запускает буферизацию операций записи, отключая запись изменений Phar-архива на диск
    • Phar::stopBuffering — Останавливает буферизацию и записывает все изменения на диск
    • Phar::unlinkArchive — Полностью удалить архив из памяти и с диска
    • Phar::webPhar — Направляет запрос из браузера во внутренний файл в phar-архиве
    To Top