RarArchive::open
rar_open
(PECL rar >= 2.0.0)
RarArchive::open -- rar_open — Відкриває архів RAR
Опис
Об'єктно-орієнтований стиль (метод):
public static RarArchive::open(string $filename, string $password = NULL, callable $volume_callback = NULL): RarArchive|false
Процедурний стиль:
rar_open(string $filename, string $password = NULL, callable $volume_callback = NULL): RarArchive|false
Відкриває зазначений RAR-архів та повертає об'єкт RarArchiveпредставляє його.
Зауваження :
При відкритті багатотомного архіву шлях до першого тому має бути переданий першим параметром. Інакше не буде видно всіх файлів.
Список параметрів
filename
Шлях до архіву Rar.
password
Пароль, якщо потрібно розшифрувати заголовки архіву. Цей пароль буде використовуватися за замовчуванням, якщо знайдено зашифровані файли. Зауважте, що файли можуть бути зашифровані з різними паролями.
volume_callback
Функція, якою передається єдиний параметр - шлях до того, який не був знайдений, і повертає рядок з правильним шляхом для цього тому або **null**якщо цей том не існує або невідомий. Розробник повинен бути впевнений, що дана функція не призведе до зациклювання, оскільки вона викликається повторно, якщо шлях, отриманий попереднім викликом, не відповідає потрібному тому. Вказівка цього параметра усуває попередження, які б з'являлися, якби тому не було знайдено. Якщо функція повертає тільки null, то не буде жодного попередження.
Увага
До версії 2.0.0 ця функція не обробляла правильно відносні шляхи. У таких випадках використовуйте realpath()
Значення, що повертаються
Повертає запитуваний об'єкт RarArchiveили**false**в случае возникновения ошибки.
список змін
| Версия | Опис |
|---|---|
| PECL rar 3.0.0 | Був доданий volume_callback |
Приклади
Приклад #1 Об'єктно-орієнтований стиль
Висновок наведеного прикладу буде схожим на:
Найдено 2 файлов.
Содержимое первого файла:
Encrypted file 1 contents.
Приклад #2 Процедурний стиль
Приклад #3 Callback-функція для тому