.. contents::

:local:

.. raw:: html

<div class="custom-index container"></div>

Using the Zip Encoding Class

Class Reference

.. class:: CI_Zip

.. method:: add_data($filepath[, $data = NULL])

:param mixed $filepath: a single file path or an array of file => data pairs

:param array $data: single file contents

:returns: void

Adds data to the Zip archive. Can work both in single and multiple files mode.

When adding a single file, the first parameter must contain the name you would like given to the file and the second must contain the file contents::

When adding multiple files, the first parameter must contain *file => contents* pairs and the second parameter is ignored::

If you would like your compressed data organized into sub-directories, simply include the path as part of the filename(s)::

The above example will place my_bio.txt inside a folder called personal.

.. method:: add_dir($directory)

Permits you to add a directory. Usually this method is unnecessary since you can place your data into directories when using

.. method:: read_file($path[, $preserve_filepath = FALSE])

:param string $path: path to file

:param bool $preserve_filepath: whether to maintain the original filepath

:returns: bool

Permits you to compress a file that already exists somewhere on your server.

Supply a file path and the zip class will read it and add it to the archive::

If you would like the Zip archive to maintain the directory structure of

the file in it, pass TRUE (boolean) in the second parameter. Example::

In the above example, photo.jpg will be placed into the *path/to/* directory.

.. method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])

:param string $path: path to directory

:param bool $preserve_filepath: whether to maintain the original path

:param string $root_path: part of the path to exclude from the archive directory

:returns: bool

Permits you to compress a directory (and its contents) that already exists somewhere on your server.

Supply a path to the directory and the zip class will recursively read and recreate it as a Zip archive.

All files contained within the supplied path will be encoded, as will any sub-directories contained within it. Example::

By default the Zip archive will place all directories listed in the first parameter inside the zip.

If you want the tree preceding the target directory to be ignored you can pass FALSE (boolean) in the second parameter. Example::

.. method:: archive($filepath)

:param string $filepath: path to target zip archive

:returns: bool

.. method:: download($filename = 'backup.zip')

:param string $filename: the archive file name

:returns: void

Causes the Zip file to be downloaded from your server. You must pass the name you would like the zip file called. Example::

.. note:: Do not display any data in the controller in which you call

this method since it sends various server headers that cause the

download to happen and the file to be treated as binary.

.. method:: get_zip()

:returns: string

Returns the Zip-compressed file data. Generally you will not need this method unless you want to do something unique with the data. Example::

.. method:: clear_data()

:returns: void

The Zip class caches your zip data so that it doesn't need to recompile the Zip archive for each method you use above.

If, however, you need to create multiple Zip archives, each with different data, you can clear the cache between calls. Example::