CachingClassLoader.php

<?php
/*
 * ZenMagick - Another PHP framework.
 * Copyright (C) 2006-2011 zenmagick.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
 */
?>
<?php
namespace zenmagick\base\classloader;

/**
 * A class loader supporting caching.
 *
 * <p>Allows to cache configuration for a given path.</p>
 *
 * @author DerManoMann <mano@zenmagick.org>
 */
class CachingClassLoader extends ClassLoader {

    /**
     * Export
     *
     * @param string path The path.
     * @return mixed All relevant data.
     */
    public function export($path) {
        // just in case
        $path = realpath($path);

        $data = array(
            'namespaces' => $this->getNamespaces(),
            'prefixes' => $this->getPrefixes(),
            'defaults' => $this->getDefaults()
        );

        $relativeData = array();
        foreach (array('namespaces', 'prefixes', 'defaults') as $key) {
            $relativeData[$key] = array();
            foreach ($data[$key] as $name => $value) {
                if (is_array($value)) {
                    $relativeData[$key][$name] = array();
                    foreach ($value as $file) {
                        $relativeData[$key][$name][] = str_replace(DIRECTORY_SEPARATOR, '/', str_replace($path.DIRECTORY_SEPARATOR, '', $file));
                    }
                } else {
                    $relativeData[$key][$name] = str_replace(DIRECTORY_SEPARATOR, '/', str_replace($path.DIRECTORY_SEPARATOR, '', $value));
                }
            }
        }

        return array(
            'namespaces' => $relativeData['namespaces'],
            'prefixes' => $relativeData['prefixes'],
            'defaults' => $relativeData['defaults']
        );
    }

    /**
     * Import
     *
     * @param mixed data The data to import.
     * @param string path The path.
     */
    public function import(array $data, $path) {
        // just in case
        $path = realpath($path);

        $absoluteData = array();
        foreach (array('namespaces', 'prefixes', 'defaults') as $key) {
            $absoluteData[$key] = array();
            foreach ($data[$key] as $name => $value) {
                if (is_array($value)) {
                    $absoluteData[$key][$name] = array();
                    foreach ($value as $file) {
                        $absoluteData[$key][$name][] = realpath($path.'/'.$file);
                    }
                } else {
                    $absoluteData[$key][$name] = realpath($path.'/'.$value);
                }
            }
        }

        $this->addNamespaces($absoluteData['namespaces']);
        $this->addPrefixes($absoluteData['prefixes']);
        $this->addDefaults($absoluteData['defaults']);
    }

    /**
     * Check if a cache file exists for a given path.
     *
     * @param string path The path.
     */
    public function hasCacheForPath($path) {
        return file_exists(realpath($path.'/classloader.cache'));
    }

    /**
     * Get cache for path (if any).
     *
     * @param string path The path.
     * @return array The cache or <code>null</code>.
     */
    public function getCacheForPath($path) {
        if (!$this->hasCacheForPath($path)) {
            return null;
        }

        return unserialize(file_get_contents(realpath($path.'/classloader.cache')));
    }

    /**
     * Export current settings to the given path.
     *
     * @param string path The path.
     */
    public function exportToPath($path) {
        $data = $this->export($path);
        file_put_contents($path.'/classloader.cache', serialize($data));
    }

    /**
     * {@inheritDoc}
     */
    public function addConfig($path) {
        if (null === ($cache = $this->getCacheForPath($path))) {
            parent::addConfig($path);
            return;
        }

        $this->import($cache, $path);
    }

}