Joomla Zip Archiver

<?php

/**
 * @version     $Id$
 * @package     Joomla
 * @subpackage  Random Code Samples
 * @link        http://www.boolcast.com/development/joomla-zip-archiver
 * @copyright   Copyright (C) 2010 Oleksandr Balyuk (www.boolcast.com)
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL v2
 */
// No direct access
defined('_JEXEC') or die('Restricted access');
jimport('joomla.filesystem.file');
require_once JPATH_LIBRARIES . 'joomla' . DS . 'filesystem' . DS . 'archive' . DS . 'zip.php';

/**
 * ZipArchiver is a wrapper class for JArchiveZip
 * Makes it easy to archive collection of files into a zip archive.
 *
 * @author Oleksandr Balyuk <obalyuk@boolcast.com>
 */
class ZipArchiver extends JObject {

    /**
     *  Exports file
     * 
     * @param array $files array with files paths
     * @param string $archive name of the archive
     * @param string $path path to the archive without slash at the end. .e.g. /path/to/directory
     * @param bool $overwrite if true will overwrite the archive if it exists
     * @return true on success
     */
    public function archive($files, $archive, $path, $overwrite=true) {

        //  Check to see if directory for archive exists
        if (!JFolder::exists($path)) {
            //  Try to create the directory if it does not exists
            if (!JFolder::create($path)) {
                //  Raise error, unable to create dir
                $this->setError('Unable to create directory for archive');
                return false;
            }
        }

        //  Check if archive exists
        $archiveFilePath = $path . DS . $archive;
        if (JFile::exists($archiveFilePath)) {
            //  If overwrite flag is set
            if ($overwrite) {
                //  Delete archive
                JFile::delete($archiveFilePath);
            } else {
                //  Set error and return
                $this->setError('Archive exists');
                return false;
            }
        }

        //  Prepare files for the zip archiver
        $filesToZip = array();
        foreach ($files as $file) {
            if (JFile::exists($file)) {
                $filesToZip[] = array(
                    'data' => JFile::read($file),
                    'name' => JFile::getName($file)
                );
            }
        }

        //  Create ZIP archiver
        $archiver = new JArchiveZip();

        //  Create Archive
        $isSuccess = $archiver->create($archiveFilePath, $filesToZip);

        //  Check of operation was successful
        if (!$isSuccess) {
            //  Set Error
            $this->setError('Unable to create archive');
        }

        //
        return $isSuccess;
    }
}