mockbox.system.core.util.Zip
|
ColdBox Platform - MockBox Version 1.2 | ||||
| FRAMES | |||||
WEB-INF.cftags.component
mockbox.system.core.util.Zip
public class Zip
A collections of functions that supports the Zip and GZip functionality by using the Java Zip file API.
| Constructor Summary | |
|---|---|
init()
|
|
| Method Summary | |
|---|---|
boolean |
AddFiles(string zipFilePath, [string files=''], [string directory=''], [string filter=''], [boolean recurse='no'], [numeric compression='9'], [boolean savePaths='no'])
Add files to a new or an existing Zip file archive |
boolean |
DeleteFiles(string zipFilePath, string files)
Delete files from an existing Zip file archive |
boolean |
Extract(string zipFilePath, [string extractPath='[runtime expression]'], [string extractFiles], [boolean useFolderNames='yes'], [boolean overwriteFiles='no'])
Extracts a specified Zip file into a specified directory |
private array |
FilesList(string directory, [string filter=''], [boolean recurse='no'])
Create an array with the file names of specified directory |
query |
List(string zipFilePath)
List the content of a specified Zip file |
private string |
PathFormat(string path)
Convert path into Windows or Unix format |
Zip |
configure()
Configure for operation |
boolean |
gzipAddFile(string gzipFilePath, string filePath)
Create a new GZip file archive |
boolean |
gzipExtract(string gzipFilePath, [string extractPath='[runtime expression]'])
Extracts a specified GZip file into a specified directory |
| Methods inherited from class WEB-INF.cftags.component |
|---|
|
| Constructor Detail |
|---|
public init()
| Method Detail |
|---|
public boolean AddFiles(string zipFilePath, [string files=''], [string directory=''], [string filter=''], [boolean recurse='no'], [numeric compression='9'], [boolean savePaths='no'])
zipFilePath - Pathname of the Zip file to add files.files - | (Chr(124)) delimited list of files to add to the Zip file. Required if argument 'directory' is not set.directory - Absolute pathname of directory to add to the Zip file. Required if argument 'files' is not set.filter - File extension filter. One filter can be applied. Only if argument 'directory' is set.recurse - Get recursive files of subdirectories. Only if argument 'directory' is set.compression - Compression level (0 through 9, 0=minimum, 9=maximum).savePaths - Save full path info.public boolean DeleteFiles(string zipFilePath, string files)
zipFilePath - Pathname of the Zip file to delete files from.files - | (Chr(124)) delimited list of files to delete from Zip file.public boolean Extract(string zipFilePath, [string extractPath='[runtime expression]'], [string extractFiles], [boolean useFolderNames='yes'], [boolean overwriteFiles='no'])
zipFilePath - Pathname of the Zip file to extract.extractPath - Pathname to extract the Zip file to.extractFiles - | (Chr(124)) delimited list of files to extract.useFolderNames - Create folders using the pathinfo stored in the Zip file.overwriteFiles - Overwrite existing files.private array FilesList(string directory, [string filter=''], [boolean recurse='no'])
directory - Absolute pathname of directory to get files list.filter - File extension filter. One filter can be applied.recurse - Get recursive files of subdirectories.public query List(string zipFilePath)
zipFilePath - Pathname of the Zip file to list the content.private string PathFormat(string path)
path - The path to convert.public Zip configure()
public boolean gzipAddFile(string gzipFilePath, string filePath)
gzipFilePath - Pathname of the GZip file to create.filePath - Pathname of a file to add to the GZip file archive.public boolean gzipExtract(string gzipFilePath, [string extractPath='[runtime expression]'])
gzipFilePath - Pathname of the GZip file to extract.extractPath - Pathname to extract the GZip file to.
|
ColdBox Platform - MockBox Version 1.2 | ||||
| FRAMES | |||||