compress

Compress a file or a directory with files.

compress(format, source, target [, includeBaseFolder] [, mode]) → returns boolean

This function requires Lucee. Not supported on Adobe ColdFusion.

compress Argument Reference

format string
Required

The format in which you want to compress the files.
Values:
  • bzip
  • bzip2
  • tbz
  • tbz2
  • tar
  • tar.bz
  • tar.gz
  • gzip
  • tgz
  • zip

source string
Required

Path (relative or absolute) to the file or directory you want to compress.

target string
Required

Path (relative or absolute) including the name, where you want to save the compressed output-file.

includeBaseFolder boolean
Default: true

Compress the directory or just the content of the directory.

mode string
Default: 777

Examples sample code invoking the compress function


Compress a file

Compress the file "example.txt" to a zip-file.

compress("zip", "example.txt", "output.zip")

Compress a directory

Compress the "example-directory" to a zip-file.

compress("zip", "example-directory", "output.zip")

Fork me on GitHub