«PHP-Creative»

 

Меню сайта


Новые статьи



Статистика

Rambler's Top100

Рейтинг@Mail.ru

Сейчас на сайте: 1

Большие возможности маленького сайта (Работа с Zip архивами) Часть 3.

Дата добавления: 2009-04-18

Автор статьи: Феськов Кузьма

PCLZIP_OPT_PREPEND_COMMENT

Позволяет добавить комментарий к архиву. Если комментарий уже существует, добавит новый комментарий перед имеющимся. $archive = new PclZip('test.zip');
$list = $archive->add("data", PCLZIP_OPT_PREPEND_COMMENT,
"Add a comment before the existing one");
if ($list == 0) {
echo "ERROR : ".$archive->errorInfo(true);
}

 

См. также PCLZIP_OPT_COMMENT и PCLZIP_OPT_ADD_COMMENT.
Возвратные функции.

Возвратные функции – специфические аргументы, потому что их значение – название функции. Эти функции имеют строгое описание и которого вы должны придерживаться. Действия, которые могут производить эти функции разграничены. Внутренний алгоритм функции может быть любым, но он должен уважать определенный список параметров и возвращаемых значений. Однако, функция должна уважать основную обработку метода, некоторое действия могут с этим столкнуться (например, удаление файла архива в течении процесса).

PCLZIP_CB_PRE_EXTRACT

Этот дополнительный аргумент дает вам возможность выполнить определенную функцию перед тем как распаковать файл. Эта функция может изменять процесс извлечения файла двумя способами:
изменить путь или имя файла;
пропустить извлечение файла.

Чтобы быть точными: эта функция применяется после дополнительных аргументов PCLZIP_OPT_PATH, PCLZIP_OPT_ADD_PATH, PCLZIP_OPT_REMOVE_PATH или PCLZIP_OPT_REMOVE_ALL_PATH, но перед конкретной проверкой (файл не существует, файла нет в текущей папке, и так далее).

Функция должна принимать в качестве аргументов следующие параметры: function myCallBack($p_event, &$p_header)
{
[... ваш код ...]
return $result;
}

Когда метод вызывает возвратную функцию, он делает это следующим образом:
$p_event – идентификатор аргумента (здесь PCLZIP_CB_PRE_EXTRACT). Это используется, когда необходимо использовать одну и ту же функцию для разных возвратных действий.
$p_header – описание файла, который будте извлечен. Это массив, который содержит информацию в нескольких полях. Наиболее интересный параметр – имя файла в архиве и имя файла, под которым он будет извлечен. Все поля массива описаны в главе “Возвращаемые данные”.

Функция может менять только поле “filename” (имя файла) в массиве $p_header. Это дает вам вам возможность изменить имя файла после распаковки. Все остальные параметры массива только для чтения.

Функция должна возвратить 2, 1 или 0 ($result). Другие значения зарезервированы на будущее. 1 – означает возобновление извлечения файла (возможно, с измененным именем файла). 0 – пропустить файл, переходим к следующему файлу. 2 – пропустить файл и остановить распаковку, даже если не достигнут конец архива. function myPreExtractCallBack($p_event, &$p_header)
{
$info = pathinfo($p_header['filename']);
// ----- пропускаем все .gif файлы
if ($info['extension'] == 'gif') {
return 0;
}
// ----- jpg файлы распаковываем в папку 'images'
else if ($info['extension'] == 'jpg') {
$p_header['filename'] = 'images/'.$info['basename'];
return 1;
}
// ----- остальные файлы просто распаковываем
else {
return 1;
}
}

$list = $archive->extract(PCLZIP_OPT_PATH, 'folder',);
PCLZIP_CB_PRE_EXTRACT, 'myPreExtractCallBack');

 

 

PCLZIP_CB_POST_EXTRACT

Этот дополнительный аргумент дает вам возможность добавить постобработку файлов во время распаковки, вызывая функцию возврата после извлечения каждого файла. Эта функция не может изменить процесс извлечения, но может выполнить определенные действия с распакованным файлом, например, переименование или удаление.

Функция должна принимать в качестве аргументов следующие параметры: function myCallBack($p_event, &$p_header)
{
[... ваш код ...]
return $result;
}

$p_event – идентификатор аргумента (здесь PCLZIP_CB_POST_EXTRACT). Это используется, когда необходимо использовать одну и ту же функцию для разных возвратных действий.
$p_header – описание файла, который будте извлечен. Это массив, который содержит информацию в нескольких полях. Наиболее интересный параметр – имя файла в архиве и имя файла, под которым он будет извлечен. Все поля массива описаны в главе “Возвращаемые данные”. Функция не может менять этот массив, потому что извлечение уже произошло.

Функция должна возвратить 1 или 2 ($result). Остальные значения зарезервированы на будущее. 1 – извлекаем дальше. 2 – останавливаем извлечение. function myPreExtractCallBack($p_event, &$p_header) { ... }

function myPostExtractCallBack($p_event, &$p_header)
{
// ----- проверяем успешность распаковки
if ($p_header['status'] == 'ok') {
// ----- читаем файл
readfile($p_header['filename']);
// ----- удаляем файл
unlink($p_header['filename'])
}
}

$list = $archive->extract(PCLZIP_OPT_PATH, 'temp',
PCLZIP_CB_PRE_EXTRACT, 'myPreExtractCallBack',
PCLZIP_CB_POST_EXTRACT, 'myPostExtractCallBack');

Таким образом, эта функция производит действия над распакованным файлом, а затем удаляет его.

Примечание, в данном конкретном примере логичнее использовать параметр PCLZIP_OPT_EXTRACT_IN_OUTPUT, так как он не создает промежуточного файла.

PCLZIP_CB_PRE_ADD

Этот параметр позволяет вам добавить обработку файла перед помещением его в архив. Вы можете, например:
изменить путь или имя файла;
пропустить извлечение файла.

Чтобы быть точными: эта функция применяется после дополнительных аргументов PCLZIP_OPT_PATH, PCLZIP_OPT_ADD_PATH, PCLZIP_OPT_REMOVE_PATH или PCLZIP_OPT_REMOVE_ALL_PATH, но перед конкретной проверкой (файл не существует, файла нет в текущей папке, и так далее).

Функция должна принимать в качестве аргументов следующие параметры: function myCallBack($p_event, &$p_header)
{
[... ваш код ...]
return $result;
}

Когда метод вызывает возвратную функцию, он делает это следующим образом:
$p_event – идентификатор аргумента (здесь PCLZIP_CB_PRE_ADD). Это используется, когда необходимо использовать одну и ту же функцию для разных возвратных действий.
$p_header – описание файла, который будте извлечен. Это массив, который содержит информацию в нескольких полях. Наиболее интересный параметр – имя файла в архиве и имя файла, под которым он будет добавлен. Все поля массива описаны в главе “Возвращаемые данные”.

Функция может менять только поле “filename” (имя файла) в массиве $p_header. Это дает вам вам возможность изменить имя файла перед запаковкой. Все остальные параметры массива только для чтения.

Функция должна возвратить 1 или 0 ($result). Другие значения зарезервированы на будущее. 1 – означает возобновление добавления файла (возможно, с измененным именем файла). 0 – пропустить файл, переходим к следующему файлу. function myPreAddCallBack($p_event, &$p_header)
{
$info = pathinfo($p_header['stored_filename']);
// ----- пропускаем .bak файлы
if ($info['extension'] == 'bak') {
return 0;
}
// ----- jpg файлы будут добавляться в папку 'images'
else if ($info['extension'] == 'jpg') {
$p_header['stored_filename'] = 'images/'.$info['basename'];
return 1;
}
// ----- остальные файлы просто добавляются
else {
return 1;
}
}

$list = $archive->add(PCLZIP_CB_PRE_ADD, 'myPreAddCallBack');

 

PCLZIP_CB_POST_ADD

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

Функция должна принимать в качестве аргументов следующие параметры: function myCallBack($p_event, &$p_header)
{
[... ваш код ...]
return $result;
}

$p_event – идентификатор аргумента (здесь PCLZIP_CB_POST_ADD). Это используется, когда необходимо использовать одну и ту же функцию для разных возвратных действий.
$p_header – описание файла, который будте извлечен. Это массив, который содержит информацию в нескольких полях. Наиболее интересный параметр – имя файла на диске и имя файла, под которым он будет добавлен. Все поля массива описаны в главе “Возвращаемые данные”. Функция не может менять этот массив, потому что добавление уже произошло.

Функция должна возвратить 1. Остальные значения зарезервированы на будущее. function myPostAddCallBack($p_event, &$p_header)
{
// ----- проверяем удачное добавление
if ($p_header['status'] == 'ok') {
// ----- перемещаем файлы в корзину
rename($p_header['filename'], 'trash/'.$p_header['filename'])
}
}

$list = $archive->extract(PCLZIP_CB_POST_ADD, 'myPostAddCallBack');

Обработка ошибок.

С версии 1.3 обработка ошибок встроена в класс для того чтобы получился единый файл. Однако вы и сейчас можете вынести обработку ошибок во внешний модуль. Читайте раздел “Настройка PCLZip”.

Когда метод возвращает код ошибки (большинство методов возвращает 0 при ошибке), код ошибки, текст ошибки и дополнительная информация доступна через методы:
errorName(); - возвращает строку с названием ошибки;
errorCode(); - возвращает значение кода ошибки;
errorInfo(); - возвращает описание, связанное с ошибкой.
Примеры обработки ошибок:

Читаем код ошибки: $list = $archive->extract(PCLZIP_OPT_PATH, "extract/folder/");
if ($list == 0) {
die ("Unrecoverable error, code ".$archive->errorCode());
}

Неустранимая ошибка, код -6.

Читаем название ошибки: $list = $archive->extract(PCLZIP_OPT_PATH, "extract/folder/");
if ($list == 0) {
die ("Unrecoverable error '".$archive->errorName()."'");
}

Неустранимая ошибка 'PCLZIP_ERR_BAD_FORMAT'.

Читаем название ошибки и ее код: $list = $archive->extract(PCLZIP_OPT_PATH, "extract/folder/");
if ($list == 0) {
die ("Unrecoverable error '".$archive->errorName(true)."'");
}

Неустранимая ошибка 'PCLZIP_ERR_BAD_FORMAT (-10)'.

Чтение описания ошибки: $list = $archive->extract(PCLZIP_OPT_PATH, "extract/folder/");
if ($list == 0) {
die ("Error : '".$archive->errorInfo()."'");
}

Ошибка: Неправильная структура архива [код -10].

Чтение полного описания: $list = $archive->extract(PCLZIP_OPT_PATH, "extract/folder/");
if ($list == 0) {
die ("Error : '".$archive->errorInfo(true)."'");
}

Ошибка: 'PCLZIP_ERR_BAD_FORMAT (-10): Неправильная структура архива'.
Класс. методы.

PclZip()

Обзор.

Этот метод – конструктор объекта.

Резюме.

PclZip($zipname);

Аргументы.

$zipname – строка – название файла формата ZIP.

Описание.

Этот метод создает объект PclZip, который работает с архивом формата ZIP. Устанавливается только имя архива, никакой проверки не производится, никаких действий не выполняется.

При создании объекта производится проверка установки zlib. Если не установлено – сообщение об ошибке.

Пример: require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
if ($archive->create('file.txt data/text.txt folder/') == 0) {
die('Error : '.$archive->errorInfo(true));
}

 

create()

Обзор.

Этот метод создает архив формата ZIP с указанными файлами.

Резюме.

create($filelist, [доп. Параметры])

Аргументы.

$filelist

Массив с названиями файлов или директорий

или

строка с названием файла или директории

или

строка с названиями файлов или директорий, разделенными запятыми.

Дополнительные аргументы:
PCLZIP_OPT_REMOVE_PATH
PCLZIP_OPT_REMOVE_ALL_PATH
PCLZIP_OPT_ADD_PATH
PCLZIP_CB_PRE_ADD
PCLZIP_CB_POST_ADD
PCLZIP_OPT_NO_COMPRESSION
PCLZIP_OPT_COMMENT

 

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

0 – ошибка.

Массив – параметры файлов (См. “Возвращаемые значения”).

Описание.

Этот метод создает архив со всеми файлами и папками, обозначенными в аргументе $filelist. После добавления всех файлов и папок структура filesystem будет запомнена.

Дополнительные аргументы аргументы дают возможность архивировать файлы с различными путями. Это позволяет помещать архивируемые файлы в другое место, а в архиве создавать необходимую структуру.

Примеры: include_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->create('file.txt,data/text.txt,folder');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

 

В этом примере мы создали архив 'archive.zip' и поместили в него файлы 'file.txt' и 'data/text.txt'. Все из папки 'folder' также было добавлено включая все вложенные поддиректории. include_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->create('data/file.txt,data/text.txt',
PCLZIP_OPT_REMOVE_PATH, 'data',
PCLZIP_OPT_ADD_PATH, 'install');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере файлы 'file.txt' и 'text.txt', которые находятся в локальной папке 'data' , добавлены в архив без папки 'data', но в папку 'install'. Они сохранены в архиве как 'install/file.txt' и 'install/text.txt'.

listContent()

Обзор.

Этот метод возвращает список свойств файлов и папок.

Резюме.

listContent()

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

0 – ошибка.

Массив – формат массива смотрите в разделе “Возвращаемые значения”.

Описание.

Этот метод возвращает содержание архива. Результат – массив, каждый элемент которого описывает архивированный файл или папку.

Пример: include_once('pclzip.lib.php');

$zip = new PclZip("test.zip");

if (($list = $zip->listContent()) == 0) {
die("Error : ".$zip->errorInfo(true));
}

for ($i=0; $i<sizeof($list); $i++) {
for(reset($list[$i]); $key = key($list[$i]); next($list[$i])) {
echo "File $i / [$key] = ".$list[$i][$key]."<br>";
}
echo "<br>";
}

 

Пример выведет следующий результат: File 0 / [filename] = data/file1.txt
File 0 / [stored_filename] = data/file1.txt
File 0 / [size] = 53
File 0 / [compressed_size] = 36
File 0 / [mtime] = 1010440428
File 0 / [comment] =
File 0 / [folder] = 0
File 0 / [index] = 0
File 0 / [status] = ok

File 1 / [filename] = data/file2.txt
File 1 / [stored_filename] = data/file2.txt
File 1 / [size] = 54
File 1 / [compressed_size] = 53
File 1 / [mtime] = 1011197724
File 1 / [comment] =
File 1 / [folder] = 0
File 1 / [index] = 1
File 1 / [status] = ok

 

extract()

Обзор.

Этот метод распаковывает файлы и папки из архива формата ZIP.

Резюме.

PclZip::extract([список параметров])

Аргументы.
PCLZIP_OPT_PATH
PCLZIP_OPT_REMOVE_PATH
PCLZIP_OPT_REMOVE_ALL_PATH
PCLZIP_OPT_ADD_PATH
PCLZIP_CB_PRE_EXTRACT
PCLZIP_CB_POST_EXTRACT
PCLZIP_OPT_SET_CHMOD
PCLZIP_OPT_BY_NAME
PCLZIP_OPT_BY_EREG
PCLZIP_OPT_BY_PREG
PCLZIP_OPT_BY_INDEX
PCLZIP_OPT_EXTRACT_AS_STRING
PCLZIP_OPT_EXTRACT_IN_OUTPUT

 

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

0 – ошибка.

Массив – массив с извлеченными файлами. Обратите внимание, если извлечение какого-либо файла терпит неудачу, то это не значит, что все извлечение потерпело неудачу. Но статус файла в массиве будет указывать на причину ошибки. (См. “Возвращаемые параметры”).

Описание.

Этот метод извлекает часть или все файлы из архива формата ZIP.

Фильтрация может быть задана дополнительными аргументами. Также вы можете изменить путь для извлечения файлов и папок. При извлечении маленьких файлов вы можете не создавать промежуточных файлов извлекая их прямо в переменную. Также вы можете отдавать распаковываемый файл напрямую пользователю (См. “Дополнительные аргументы”).

Примеры: require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
if ($archive->extract() == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере все файлы будут извлечены в текущую директорию. include('pclzip.lib.php');
$archive = new PclZip('archive.zip');
if ($archive->extract(PCLZIP_OPT_PATH, 'data',
PCLZIP_OPT_REMOVE_PATH, 'install/release') == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере все файл извлечены в папку 'data'. Все файлы с префиксом 'install/release' также распакованы в папку 'data', а не в 'data/install/release'.

properties()

Обзор.

Этот метод отдает общие свойства архива в формате ZIP.

Резюме.

PclZip::properties()

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

0 – ошибка.

Массив – массив со свойствами архива.

Описание.

Этот метод возвращает общие свойства архива формата ZIP.

Доступные свойства:
nb – число папок/файлов в архиве.
comment – комментарий, связанный с архивом.
status – статус архива (сейчас доступен только ОК).

 

add()

Обзор.

Этот метод добавляет файлы или папки в архиву формата ZIP.

Резюме.

PclZip::add($filelist, [доп. параметры])

Аргументы.

$filelist

Массив с названиями файлов или директорий

или

строка с названием файла или директории

или

строка с названиями файлов или директорий, разделенными запятыми.

Дополнительные параметры.
PCLZIP_OPT_REMOVE_PATH
PCLZIP_OPT_REMOVE_ALL_PATH
PCLZIP_OPT_ADD_PATH
PCLZIP_CB_PRE_ADD
PCLZIP_CB_POST_ADD
PCLZIP_OPT_NO_COMPRESSION
PCLZIP_OPT_COMMENT
PCLZIP_OPT_ADD_COMMENT
PCLZIP_OPT_PREPEND_COMMENT

 

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

0 – ошибка.

Массив – см. “Возвращаемые значения”.

Описание.

Этот метод позволяет добавлять в уже существующий архив файлы, перечисленные в $filelist. После добавления всех файлов и папок структура filesystem запоминается.

Будте осторожны, если такой файл в архиве уже существует, то он добавится в конец архива, но не заменит существующий.

Если архив не существует, он будет автоматически создан.

Описание дополнительных аргументов смотрите в соответствующей главе.

Примеры: require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->add('file.txt,data/text.txt,folder/');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере в архив добавляются файл 'file.txt', 'date/text.txt' и все содержимое папки 'folder'. require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->add('dev/file.txt,dev/text.txt',
PCLZIP_OPT_ADD_PATH, 'install',
PCLZIP_OPT_REMOVE_PATH, 'dev');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере файлы 'dev/file.txt' и 'dev/text.txt' добавляются в архив, однако, путь 'dev' удалена и заменена на 'install'. Поэтому файлы в архиве сохранены как 'install/file.txt' и 'install/text.txt'.

delete()

Обзор.

Этот метод позволяет удалить из архива все или часть файлов.

Резюме.

PclZip::delete([список параметров])

Аргументы.
PCLZIP_OPT_BY_NAME
PCLZIP_OPT_BY_EREG
PCLZIP_OPT_BY_PREG
PCLZIP_OPT_BY_INDEX

 

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

0 – ошибка.

Массив – Список файлов и их свойства (оставшихся в архиве). Формат массива см. “Возвращаемые параметры”.

Описание.

Этот метод удаляет все или часть файлов, находящихся в архиве.

Вы можете использовать аргументы для организации фильтра.

Примеры: require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->delete();
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере из архива будут удален все файлы. require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->delete(PCLZIP_OPT_BY_INDEX, '1-3,5,8-10');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом образце будут удалены файлы в индексе 1-3, 5 и 8-10. Файлы и папки могут быть получены методом listContent().

Примечание, папка имеет свой собственный вход (с ее собственным индексом). При удалении папки, файлы, принадлежащие ей, удалены не будут. require_once('pclzip.lib.php');
$archive = new PclZip('archive.zip');
$v_list = $archive->delete(PCLZIP_OPT_BY_EREG, 'txt$');
if ($v_list == 0) {
die("Error : ".$archive->errorInfo(true));
}

В этом примере будут удалены все файлы, заканчивающиеся на .txt.

merge()

Обзор.

Склеивает два архива. Добавляет новый архив в конец имеющегося.

Резюме.

PclZip::merge($archive_filename)

Аргументы.

$archive_filename

Имя файла архива, с которым будет происходить объединение.

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

0 – ошибка.

1 – удача.

Описание.

Функция добавляет содержимое архива с именем $archive_filename к текущем архиву. Никакой проверки делаться не будет, например, дубликаты файлов обнаружены не будут. Это не функция обновления! Эта функция “глупо” склеивает два архива.

duplicate()

Обзор.

Дублирует архив.

Резюме.

PclZip::duplicate($archive_filename)

Аргументы.

$acrhive_filename

Имя архива для дублирования.

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

0 – ошибка.

1 – удача.

Описание.

Эта функция создает копию архива с именем из $archive_filename. Объект PclZip должен быть только создан. К нему не должны применяться никакие действия. Если связать его с уже существующим архивом, то этот архив будет удален и заменен дублируемым архивом.

На этом все – удачной работы!

Просмотров: 7159

Комментарии к данной статье:

К данной статье нет комментариев.

Добавить новый комментарий:

Введите сумму чисел с картинки:

Реклама