Phar::decompress
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
Phar::decompress — Розпаковує весь Phar-архів
Опис
public Phar::decompress(?string $extension = null): ?Phar
Зауваження :
Для коректної роботи з об'єктами Phar цьому методу необхідне встановлення значення php.ini
phar.readonlyв . В іншому випадку, буде викинуто виняток PharException
Що стосується phar-архівами, заснованими на tar чи phar, цей метод розпаковує весь архів.
У випадку з phar-архівами, що базуються на zip, виклик даного методу зазнає невдачі і буде кинуто виняток. Для розпакування архіву, стиснутого за алгоритмом gzip, має бути включений модуль zlib; для розпакування архіву, стиснутого за алгоритмом bzip2, має бути включений модуль bzip2. Як і у випадку з іншим функціоналом, що модифікує зміст phar-архіву, для успішної роботи даного методу необхідно, щоб INI-змінна phar.readonly було відключено.
Крім того, цей метод автоматично змінює розширення файлу архіву: за замовчуванням .phar для phar-архівів та .phar.tar для phar-архівів, що базуються на tar. Як альтернатива розширення файлу може бути задано за допомогою другого параметра.
Список параметрів
extension
Розширення розпакованого файлу за замовчуванням є .pharи.phar.tar. Цей параметр можна використовувати для завдання іншого розширення розпакованого файлу. Майте на увазі, що всі виконувані phar-архіви повинні містити .pharв имени файла.
Значення, що повертаються
Повертає об'єкт Phar у разі успішного виконання та **null**в случае возникновения ошибки.
Помилки
Викидає виняток BadMethodCallException, если INI-переменнаяphar.readonlyвключена, модульzlib не доступний або модуль bzip2 не увімкнуто.
список змін
| Версия | Опис |
|---|---|
| 8.0.0 | extension тепер допускає значення null. |
Приклади
Приклад #1 Приклад використання Phar::decompress()****
Дивіться також
- PharFileInfo::getCompressedSize() - Отримати реальний розмір файлу на диску з урахуванням стиснення
- PharFileInfo::isCompressed() - Перевірити, чи стиснутий файл
- PharFileInfo::compress() - Стиснути поточний файл за допомогою zlib або bzip2
- PharFileInfo::decompress() - Розтискає поточний файл
- PharData::compress() - Стискає весь архів tar/zip, використовуючи стиснення Gzip або Bzip2
- Phar::canCompress() - Перевіряє, чи підтримує модуль phar стиск з використанням zlib або bzip2
- Phar::isCompressed() - Повертає Phar::GZ або PHAR::BZ2, якщо phar-архів стиснутий повністю (.tar.gz/tar.bz і так далі)
- Phar::compress() - Стискає весь Phar-архів за допомогою Gzip- або Bzip2-стиснення
- Phar::getSupportedCompression() - Повертає масив підтримуваних алгоритмів стиснення
- Phar::compressFiles() - Стискає всі файли у поточному Phar-архіві
- Phar::decompressFiles() - Розпаковує всі файли в поточному Phar-архіві