CI_Zip Class Reference

List of all members.

Public Member Functions
	CI_Zip ()
	add_dir ($directory)
	Add Directory.
	_add_dir ($dir)
	Add Directory.
	add_data ($filepath, $data=NULL)
	Add Data to Zip.
	_add_data ($filepath, $data)
	Add Data to Zip.
	read_file ($path, $preserve_filepath=FALSE)
	Read the contents of a file and add it to the zip.
	read_dir ($path)
	Read a directory and add it to the zip.
	get_zip ()
	Get the Zip file.
	archive ($filepath)
	Write File to the specified directory.
	download ($filename= 'backup.zip')
	Download.
	clear_data ()
	Initialize Data.
Public Attributes
	$zipdata = ''
	$directory = ''
	$entries = 0
	$file_num = 0
	$offset = 0

---

Detailed Description

Definition at line 33 of file Zip.php.

---

Member Function Documentation

CI_Zip::_add_data	(	$	filepath,
		$	data
	)

Add Data to Zip.

private

Parameters:

	string	the file name/path
	string	the data to be encoded

Returns:

void

Definition at line 153 of file Zip.php.

Referenced by add_data().

        {
                $filepath = str_replace("\\", "/", $filepath);

                $uncompressed_size = strlen($data);
                $crc32  = crc32($data);

                $gzdata = gzcompress($data);
                $gzdata = substr($gzdata, 2, -4);
                $compressed_size = strlen($gzdata);

                $this->zipdata .=
                        "\x50\x4b\x03\x04\x14\x00\x00\x00\x08\x00\x00\x00\x00\x00"
                        .pack('V', $crc32)
                        .pack('V', $compressed_size)
                        .pack('V', $uncompressed_size)
                        .pack('v', strlen($filepath)) // length of filename
                        .pack('v', 0) // extra field length
                        .$filepath
                        .$gzdata; // "file data" segment

                $this->directory .=
                        "\x50\x4b\x01\x02\x00\x00\x14\x00\x00\x00\x08\x00\x00\x00\x00\x00"
                        .pack('V', $crc32)
                        .pack('V', $compressed_size)
                        .pack('V', $uncompressed_size)
                        .pack('v', strlen($filepath)) // length of filename
                        .pack('v', 0) // extra field length
                        .pack('v', 0) // file comment length
                        .pack('v', 0) // disk number start
                        .pack('v', 0) // internal file attributes
                        .pack('V', 32) // external file attributes - 'archive' bit set
                        .pack('V', $this->offset) // relative offset of local header
                        .$filepath;

                $this->offset = strlen($this->zipdata);
                $this->entries++;
                $this->file_num++;
        }

Here is the caller graph for this function:

CI_Zip::_add_dir

(

$

dir

)

Add Directory.

private

Parameters:

string

the directory name

Returns:

void

Definition at line 79 of file Zip.php.

Referenced by add_dir().

        {
                $dir = str_replace("\\", "/", $dir);

                $this->zipdata .=
                        "\x50\x4b\x03\x04\x0a\x00\x00\x00\x00\x00\x00\x00\x00\x00"
                        .pack('V', 0) // crc32
                        .pack('V', 0) // compressed filesize
                        .pack('V', 0) // uncompressed filesize
                        .pack('v', strlen($dir)) // length of pathname
                        .pack('v', 0) // extra field length
                        .$dir
                        // below is "data descriptor" segment
                        .pack('V', 0) // crc32
                        .pack('V', 0) // compressed filesize
                        .pack('V', 0); // uncompressed filesize

                $this->directory .=
                        "\x50\x4b\x01\x02\x00\x00\x0a\x00\x00\x00\x00\x00\x00\x00\x00\x00"
                        .pack('V',0) // crc32
                        .pack('V',0) // compressed filesize
                        .pack('V',0) // uncompressed filesize
                        .pack('v', strlen($dir)) // length of pathname
                        .pack('v', 0) // extra field length
                        .pack('v', 0) // file comment length
                        .pack('v', 0) // disk number start
                        .pack('v', 0) // internal file attributes
                        .pack('V', 16) // external file attributes - 'directory' bit set
                        .pack('V', $this->offset) // relative offset of local header
                        .$dir;

                $this->offset = strlen($this->zipdata);
                $this->entries++;
        }

Here is the caller graph for this function:

CI_Zip::add_data	(	$	filepath,
		$	data = NULL
	)

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.

public

Parameters:

	mixed
	string

Returns:

void

Definition at line 128 of file Zip.php.

References _add_data().

Referenced by read_dir(), and read_file().

        {
                if (is_array($filepath))
                {
                        foreach ($filepath as $path => $data)
                        {
                                $this->_add_data($path, $data);
                        }
                }
                else
                {
                        $this->_add_data($filepath, $data);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Zip::add_dir

(

$

directory

)

Add Directory.

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

public

Parameters:

mixed

the directory name. Can be string or array

Returns:

void

Definition at line 57 of file Zip.php.

References $directory, and _add_dir().

        {
                foreach ((array)$directory as $dir)
                {
                        if ( ! preg_match("|.+/$|", $dir))
                        {
                                $dir .= '/';
                        }

                        $this->_add_dir($dir);
                }
        }

Here is the call graph for this function:

CI_Zip::archive

(

$

filepath

)

Write File to the specified directory.

Lets you write a file

public

Parameters:

string

the file name

Returns:

bool

Definition at line 296 of file Zip.php.

References get_zip().

        {
                if ( ! ($fp = @fopen($filepath, FOPEN_WRITE_CREATE_DESTRUCTIVE)))
                {
                        return FALSE;
                }

                flock($fp, LOCK_EX);    
                fwrite($fp, $this->get_zip());
                flock($fp, LOCK_UN);
                fclose($fp);

                return TRUE;    
        }

Here is the call graph for this function:

CI_Zip::CI_Zip

(

)

Definition at line 41 of file Zip.php.

References log_message().

        {
                log_message('debug', "Zip Compression Class Initialized");
        }

Here is the call graph for this function:

CI_Zip::clear_data

(

)

Initialize Data.

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

public

Returns:

void

Definition at line 347 of file Zip.php.

        {
                $this->zipdata          = '';
                $this->directory        = '';
                $this->entries          = 0;
                $this->file_num         = 0;
                $this->offset           = 0;
        }

CI_Zip::download

(

$

filename = 'backup.zip'

)

Download.

public

Parameters:

	string	the file name
	string	the data to be encoded

Returns:

bool

Definition at line 321 of file Zip.php.

References $CI, get_instance(), and get_zip().

        {
                if ( ! preg_match("|.+?\.zip$|", $filename))
                {
                        $filename .= '.zip';
                }

                $zip_content =& $this->get_zip();

                $CI =& get_instance();
                $CI->load->helper('download');

                force_download($filename, $zip_content);
        }

Here is the call graph for this function:

CI_Zip::get_zip

(

)

Get the Zip file.

public

Returns:

binary string

Definition at line 266 of file Zip.php.

Referenced by archive(), and download().

        {
                // Is there any data to return?
                if ($this->entries == 0)
                {
                        return FALSE;
                }

                $zip_data = $this->zipdata;
                $zip_data .= $this->directory."\x50\x4b\x05\x06\x00\x00\x00\x00";
                $zip_data .= pack('v', $this->entries); // total # of entries "on this disk"
                $zip_data .= pack('v', $this->entries); // total # of entries overall
                $zip_data .= pack('V', strlen($this->directory)); // size of central dir
                $zip_data .= pack('V', strlen($this->zipdata)); // offset to start of central dir
                $zip_data .= "\x00\x00"; // .zip file comment length

                return $zip_data;
        }

Here is the caller graph for this function:

CI_Zip::read_dir

(

$

path

)

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.

public

Parameters:

string

path to source

Returns:

bool

Definition at line 236 of file Zip.php.

References add_data().

        {       
                if ($fp = @opendir($path))
                {
                        while (FALSE !== ($file = readdir($fp)))
                        {
                                if (@is_dir($path.$file) && substr($file, 0, 1) != '.')
                                {                                       
                                        $this->read_dir($path.$file."/");
                                }
                                elseif (substr($file, 0, 1) != ".")
                                {
                                        if (FALSE !== ($data = file_get_contents($path.$file)))
                                        {                                               
                                                $this->add_data(str_replace("\\", "/", $path).$file, $data);
                                        }
                                }
                        }
                        return TRUE;
                }
        }

Here is the call graph for this function:

CI_Zip::read_file	(	$	path,
		$	preserve_filepath = FALSE
	)

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

public

Returns:

bool

Definition at line 201 of file Zip.php.

References add_data().

        {
                if ( ! file_exists($path))
                {
                        return FALSE;
                }

                if (FALSE !== ($data = file_get_contents($path)))
                {
                        $name = str_replace("\\", "/", $path);
                        
                        if ($preserve_filepath === FALSE)
                        {
                                $name = preg_replace("|.*/(.+)|", "\\1", $name);
                        }

                        $this->add_data($name, $data);
                        return TRUE;
                }
                return FALSE;
        }

Here is the call graph for this function:

---

Member Data Documentation

CI_Zip::$directory = ''

Definition at line 36 of file Zip.php.

Referenced by add_dir().

CI_Zip::$entries = 0

Definition at line 37 of file Zip.php.

CI_Zip::$file_num = 0

Definition at line 38 of file Zip.php.

CI_Zip::$offset = 0

Definition at line 39 of file Zip.php.

CI_Zip::$zipdata = ''

Definition at line 35 of file Zip.php.

---

The documentation for this class was generated from the following file:

• Zip.php