Spec-Zone.ru › ColdFusion

cfzip

Работает с файлами ZIP и JavaTM Archive (JAR). Помимо основных функций архивирования и распаковки, тег cfzip позволяет удалять записи из архива, фильтровать файлы, читать файлы в двоичном формате, выводить список содержимого архива и задавать путь к записи, используемый в исполняемом JAR-файле.

<cfzip>

cfzip();

  • CF8+
  • Lucee
  • BL 1.0.0+
    • См. также: compress cfzipparam

    Справочник по атрибутам

    action string
    По умолчанию: zip

    Выполняемое действие. Должно быть одним из следующих: delete list read readBinary unzip zip Если действие не указано, ColdFusion использует действие по умолчанию — zip. (необязательный)
    Значения:
    • delete
    • list
    • read
    • readBinary
    • unzip
    • zip

    charset string

    Кодировка, используемая для преобразования записи ZIP или JAR в текстовую строку. Примеры кодировок: JIS RFC1345 UTF-16 (необязательный, по умолчанию используется кодировка хост-компьютера)
    Значения:
    • JIS
    • RFC1345
    • UTF-16

    destination string

    Каталог назначения, в который извлекается файл ZIP или JAR. (необязательный)

    entrypath string

    Путь, для которого выполняется действие. (необязательный)

    file string

    Абсолютный путь к файлу, для которого выполняется действие. Например, полный путь к ZIP-файлу: c:\temp\log.zip. Если полный путь не указан (например, file="log.zip"), ColdFusion создаёт файл во временном каталоге. Чтобы получить доступ к ZIP- или JAR-файлу, можно использовать функцию GetTempDirectory. (обязательный)

    filter string

    Фильтр файлов, применяемый к действию. Действие применяется ко всем файлам в указанном пути, соответствующим фильтру. (необязательный)

    name string

    Имя набора записей, в котором хранится результат действия list. Столбцы набора записей: name: имя файла записи в JAR-файле. Например, если запись имеет путь help/docs/index.htm, имя — index.htm. directory: каталог, содержащий запись. В приведённом выше примере каталог — help/docs. Полное имя записи можно получить, объединив directory и name. Если запись находится в корневом каталоге, значением directory является пустая строка (''). size: размер записи в байтах без сжатия. compressedSize: размер записи в байтах после сжатия. type: тип записи (каталог или файл). dateLastModified: дата последнего изменения записи, объект cfdate. comment: комментарий к записи, если он есть. crc: контрольная сумма CRC-32 несжатых данных записи. (обязательный)

    overwrite boolean

    unzip: указывает, следует ли перезаписывать извлечённые файлы: yes: если извлечённый файл уже существует в указанном месте назначения, он перезаписывается. no: если извлечённый файл уже существует в указанном месте назначения, он не перезаписывается, а соответствующая запись не извлекается. Остальные записи извлекаются. zip: указывает, следует ли перезаписывать содержимое файла ZIP или JAR: yes: перезаписывает всё содержимое существующего файла ZIP или JAR. no: обновляет существующие записи и добавляет новые записи в существующий файл ZIP или JAR. (необязательный, по умолчанию=no)
    Значения:
    • true
    • false

    password string

    Пароль, используемый для архива при выполнении действия zip. (необязательный)

    prefix string

    Строка, добавляемая в качестве префикса к записи ZIP или JAR. Эта строка представляет собой имя подкаталога, в который добавляются записи. (необязательный)

    recurse boolean

    Указывает, применяется ли действие к подкаталогам: yes: включает подкаталоги. no: не включает подкаталоги. (необязательный, по умолчанию=yes)
    Значения:
    • true
    • false

    showDirectory boolean

    yes: выводит список каталогов. no: не выводит список каталогов. (необязательный, по умолчанию= no)
    Значения:
    • true
    • false

    source string

    Исходный каталог для архивирования. Не требуется, если указан cfzipparam. (обязательный)

    storePath boolean

    zip: указывает, сохраняются ли пути к файлам в файле ZIP или JAR: yes: пути к записям сохраняются в файле ZIP или JAR. no: пути к записям не сохраняются в файле ZIP или JAR. Все файлы помещаются в корневой каталог. При конфликте имён добавляется последний файл в порядке итерации. unzip: указывает, извлекаются ли файлы по пути entrypath: yes: файлы извлекаются по пути entrypath. no: путь entrypath игнорируется, и все файлы извлекаются в корневой каталог. (необязательный, по умолчанию= yes)
    Значения:
    • true
    • false

    variable string

    Переменная, в которой хранится прочитанное содержимое. (обязательный)

    Совместимость

    BoxLang:

    Версия 1.0.0+ <bx:zip> в BoxLang

    Ссылки дополнительная информация о cfzip

    • Изучаем ColdFusion 8: CFZip, часть IV — извлечение ZIP-архивов — Ben Nadel: различные варианты использования cfzip

    Примеры
    Примеры кода с использованием тега cfzip

    Извлечение / распаковка ZIP-файла в папку

    Использует action="unzip" в теге cfzip для распаковки во временный каталог.

    <cfzip action="unzip" destination="#getTempDirectory()#" file="#zipFilePath#">

    Извлечение / распаковка ZIP-файла в папку (синтаксис скрипта)

    Использует action="unzip" в теге cfzip для распаковки во временный каталог.

    cfzip(action="unzip", file="zipFileName", destination=getTempDirectory());

    Список содержимого ZIP-папки (синтаксис скрипта)

    Использует action="list" в теге cfzip для вывода списка содержимого ZIP-архива.

    cfzip(action="list", file="zipFileName", name="zipList");

    © 2012–present Foundeo, Inc. and the CFDocs contributors.
    Licensed under the MIT License.
    ColdFusion is a trademark of Adobe Systems Incorporated.
    https://cfdocs.org/cfzip

    Spec-Zone.ru

    Настройки Оффлайн Что нового Помощь О нас
    Spec-Zone .ru
    спецификации, руководства, описания, API