CodeIgniter v3.0.0 API
\

\CI_Zip

Zip Compression Class

This class is based on a library I found at Zend: http://www.zend.com/codex.php?id=696&single=1

The original library is a little rough around the edges so I refactored it and added several additional methods -- Rick Ellis

Summary

Methods
Properties
Constants
__construct()
add_dir()
add_data()
read_file()
read_dir()
get_zip()
archive()
download()
clear_data()
$zipdata
$directory
$entries
$file_num
$offset
$now
$compression_level
No constants found
_get_mod_time()
_add_dir()
_add_data()
strlen()
substr()
$func_overload
N/A
No private methods found
No private properties found
N/A

Properties

$zipdata

$zipdata : string

Zip data in string form

Type

string

$directory

$directory : string

Zip data for a directory in string form

Type

string

$entries

$entries : integer

Number of files/folder in zip file

Type

integer

$file_num

$file_num : integer

Number of files in zip

Type

integer

$offset

$offset : integer

relative offset of local header

Type

integer

$now

$now : integer

Reference to time at init

Type

integer

$compression_level

$compression_level : integer

The level of compression

Ranges from 0 to 9, with 9 being the highest level.

Type

integer

$func_overload

$func_overload : boolean

mbstring.func_overload flag

Type

boolean

Methods

__construct()

__construct() : void

Initialize zip compression class

add_dir()

add_dir(mixed  $directory) : void

Add Directory

Lets you add a virtual directory into which you can place files.

Parameters

mixed $directory

the directory name. Can be string or array

add_data()

add_data(mixed  $filepath, string  $data = NULL) : void

Add Data to Zip

Lets you add files to the archive. If the path is included in the filename it will be placed within a directory. Make sure you use add_dir() first to create the folder.

Parameters

mixed $filepath

A single filepath or an array of file => data pairs
string $data

Single file contents

read_file()

read_file(string  $path, boolean  $archive_filepath = FALSE) : boolean

Read the contents of a file and add it to the zip

Parameters

string $path
boolean $archive_filepath

Returns

boolean

read_dir()

read_dir(string  $path, boolean  $preserve_filepath = TRUE, string  $root_path = NULL) : boolean

Read a directory and add it to the zip.

This function recursively reads a folder and everything it contains (including sub-folders) and creates a zip based on it. Whatever directory structure is in the original file path will be recreated in the zip file.

Parameters

string $path

path to source directory
boolean $preserve_filepath
string $root_path

Returns

boolean

get_zip()

get_zip() : string

Get the Zip file

Returns

string —

(binary encoded)

archive()

archive(string  $filepath) : boolean

Write File to the specified directory

Lets you write a file

Parameters

string $filepath

the file name

Returns

boolean

download()

download(string  $filename = 'backup.zip') : void

Download

Parameters

string $filename

the file name

clear_data()

clear_data() : \CI_Zip

Initialize Data

Lets you clear current zip data. Useful if you need to create multiple zips with different data.

Returns

\CI_Zip

_get_mod_time()

_get_mod_time(string  $dir) : array

Get file/directory modification time

If this is a newly created file/dir, we will set the time to 'now'

Parameters

string $dir

path to file

Returns

array —

filemtime/filemdate

_add_dir()

_add_dir(string  $dir, integer  $file_mtime, integer  $file_mdate) : void

Add Directory

Parameters

string $dir

the directory name
integer $file_mtime
integer $file_mdate

_add_data()

_add_data(string  $filepath, string  $data, integer  $file_mtime, integer  $file_mdate) : void

Add Data to Zip

Parameters

string $filepath

the file name/path
string $data

the data to be encoded
integer $file_mtime
integer $file_mdate

strlen()

strlen(string  $str) : integer

Byte-safe strlen()

Parameters

string $str

Returns

integer

substr()

substr(string  $str, integer  $start, integer  $length = NULL) : string

Byte-safe substr()

Parameters

string $str
integer $start
integer $length

Returns

string