safeUnZip

Описание и параметры

array
CIBlockXMLFile::safeUnZip(
	string $fileName, 
	?int $lastIndex = null, 
	int $interval = 0
);

Метод распаковывает ZIP-архив из файла fileName. Cтатический метод.

Параметры вызова

Параметр	Описание
fileName	Путь к ZIP-архиву относительно корня сайта.
lastIndex	Порядковый номер последнего, уже распакованного файла. В начале работы (т.е. на первом шаге) параметр принимает значение null.
interval	Длительность одного шага распаковки архива в секундах. При значении 0 распаковка выполняется за один шаг.

Возвращаемые значения

Ассоциативный массив с ключами:

Ключ	Описание
STATUS	Результат шага распаковки. В качестве значения принимает одну из трех констант: UNPACK_STATUS_ERROR - ошибка распаковки; UNPACK_STATUS_CONTINUE - распаковка архива за шаг не закончена, необходимо продолжить; UNPACK_STATUS_FINAL - распаковка завершена полностью.
DATA	Массив содержит служебные данные. Имеет смысл только в том случае, если распаковка не завершена за один шаг. Ключ массива: LAST_INDEX - порядковый номер последнего извлеченного файла из архива за текущий шаг.

Ключ

Описание

STATUS

Результат шага распаковки. В качестве значения принимает одну из трех констант:

UNPACK_STATUS_ERROR - ошибка распаковки;
UNPACK_STATUS_CONTINUE - распаковка архива за шаг не закончена, необходимо продолжить;
UNPACK_STATUS_FINAL - распаковка завершена полностью.

DATA

Массив содержит служебные данные. Имеет смысл только в том случае, если распаковка не завершена за один шаг.

Ключ массива:

LAST_INDEX - порядковый номер последнего извлеченного файла из архива за текущий шаг.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх