| alpha--util--cache

# Source for file AlphaCacheProviderFactory.inc Documentation is available at AlphaCacheProviderFactory.inc <?php /** * * A factory for creating cache provider implementations that implement the * AlphaCacheProviderInterface interface. * * @package alpha::util::cache * @since 1.1 * @author John Collins <dev@alphaframework.org> * @version $Id: AlphaCacheProviderFactory.inc 1454 2011-12-04 15:14:05Z johnc $ * @license http://www.opensource.org/licenses/bsd-license.php The BSD License * @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework). * All rights reserved. * * <pre> * Redistribution and use in source and binary forms, with or * without modification, are permitted provided that the * following conditions are met: * * * Redistributions of source code must retain the above * copyright notice, this list of conditions and the * following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the * following disclaimer in the documentation and/or other * materials provided with the distribution. * * Neither the name of the Alpha Framework nor the names * of its contributors may be used to endorse or promote * products derived from this software without specific * prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * </pre> * */ class AlphaCacheProviderFactory { /** * Trace logger * * @var Logger * @since 1.1 */ private static $logger = null; /** * A static method that attempts to return a AlphaCacheProviderInterface instance * based on the name of the provider class supplied. * * @param $providerName The class name of the provider class, should be in the alpha::util::cache package. * @throws IllegalArguementException * @return AlphaCacheProviderInterface * @since 1.1 */ public static function getInstance($providerName) { if(self::$logger == null) self::$logger = new Logger('AlphaCacheProviderFactory'); self::$logger->debug('>>getInstance(providerName=['.$providerName.'])'); global $config; if(file_exists($config->get('sysRoot').'alpha/util/cache/'.$providerName.'.inc')) { require_once $config->get('sysRoot').'alpha/util/cache/'.$providerName.'.inc'; $instance = new $providerName; if(!$instance instanceof AlphaCacheProviderInterface) throw new IllegalArguementException('The class ['.$providerName.'] does not implement the expected AlphaCacheProviderInterface intwerface!'); self::$logger->debug('<<getInstance: [Object '.$providerName.']'); return $instance; }else{ throw new IllegalArguementException('The class ['.$providerName.'] is not defined anywhere!'); } self::$logger->debug('<<getInstance'); } } ?> Documentation generated on Tue, 13 Dec 2011 20:25:31 +0000 by phpDocumentor 1.4.3