Docs
- Home
-
Quick Index
- Introduction
- ColdBox Overview
- Directory Layout & Conventions
- Request Life Cycles
- Application Bootstrapper
- Configuring
- Application Configuration
- Using configuration settings
- Fun Logging with LogBox
- Models
- ColdBox Models
- Dependency Injection via WireBox
- Active Entity
- Built-in ORM Services
- Hibernate Criteria Builder
- ORM Event Handling
- Views
- Layouts and Rendering in ColdBox
- Controllers
- Event Handlers
- ColdBox SES URL Mappings
- Object and Form Validation
- Request Context
- Request Context
- Extending the Request Context
- Tumble Down The Rabbit Hole...
- Flash RAM & Webflows
- Ajax Integration
- Powering Flex/Air/SOAP/REST Apps
- Caching with CacheBox
- Localization & i18n
- ColdBox Security
- Aspect Oriented Programming
- ColdBox Recipes
- Extending ColdBox
- ColdBox Modules & Architecture
- ColdBox Plugins
- Core Plugins Browser
- ColdBox Interceptors
- Core Interceptors Browser
- Testing
- Testing ColdBox Applications
- Mocking-Stubbing with MockBox
- Tools, IDE Extras
- ColdBox Platform Utilities
- IDE Syntax Dictionaries
- Standalone Projects
- ColdBox Cheatsheet
- API Docs
- Directory
SideBar
User Login 
Plugins:Zip
last edited by
lmajano
on 11-Apr-2010
lmajano
on 11-Apr-2010
|
Exploring the Zip Plugin
Overview
A collections of functions that supports the Zip and GZip functionality by using the Java Zip file API.
gzipExtract
Extracts a specified GZip file into a specified directory.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| gzipFilePath | string | Yes | --- | Pathname of the GZip file to extract. |
| extractPath | string | No | [runtime expression] | Pathname to extract the GZip file to. |
Examples
list
List the content of a specified Zip file.
Returns
- This function returns query
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| zipFilePath | string | Yes | --- | Pathname of the Zip file to list the content. |
Examples
extract
Extracts a specified Zip file into a specified directory.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| zipFilePath | string | Yes | --- | Pathname of the Zip file to extract. |
| extractPath | string | No | [runtime expression] | Pathname to extract the Zip file to. |
| extractFiles | string | No | --- | (Chr(124)) delimited list of files to extract. |
| useFolderNames | boolean | No | yes | Create folders using the pathinfo stored in the Zip file. |
| overwriteFiles | boolean | No | no | Overwrite existing files. |
Examples
gzipAddFile
Create a new GZip file archive.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| gzipFilePath | string | Yes | --- | Pathname of the GZip file to create. |
| filePath | string | Yes | --- | Pathname of a file to add to the GZip file archive. |
Examples
deleteFiles
Delete files from an existing Zip file archive.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| zipFilePath | string | Yes | --- | Pathname of the Zip file to delete files from. |
| files | string | Yes | --- | (Chr(124)) delimited list of files to delete from Zip file. |
Examples
addFiles
Add files to a new or an existing Zip file archive.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| zipFilePath | string | Yes | --- | Pathname of the Zip file to add files. |
| files | string | No | (Chr(124)) delimited list of files to add to the Zip file. Required if argument 'directory' is not set. | |
| directory | string | No | Absolute pathname of directory to add to the Zip file. Required if argument 'files' is not set. | |
| filter | string | No | File extension filter. One filter can be applied. Only if argument 'directory' is set. | |
| recurse | boolean | No | no | Get recursive files of subdirectories. Only if argument 'directory' is set. |
| compression | numeric | No | 9 | Compression level (0 through 9, 0=minimum, 9=maximum). |
| savePaths | boolean | No | no | Save full path info. |
Comments (