The API

• 1.2.0.7296 RC2
• 1.2 Tests
• 1.1.19.6971

• About CakePHP
• Donate

• CakePHP
• API
• Docs
• Bakery
• Live
• Forge
• Trac

class_registry.php

Go to the documentation of this file.

<?php
/* SVN FILE: $Id: class__registry_8php-source.html 580 2008-07-01 14:45:49Z gwoo $ */
/**
 * Class collections.
 *
 * A repository for class objects, each registered with a key.
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework <http://www.cakephp.org/>
 * Copyright 2005-2008, Cake Software Foundation, Inc.
 *                              1785 E. Sahara Avenue, Suite 490-204
 *                              Las Vegas, Nevada 89104
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright       Copyright 2005-2008, Cake Software Foundation, Inc.
 * @link                http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
 * @package         cake
 * @subpackage      cake.cake.libs
 * @since           CakePHP(tm) v 0.9.2
 * @version         $Revision: 580 $
 * @modifiedby      $LastChangedBy: gwoo $
 * @lastmodified    $Date: 2008-07-01 09:45:49 -0500 (Tue, 01 Jul 2008) $
 * @license         http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Class Collections.
 *
 * A repository for class objects, each registered with a key.
 * If you try to add an object with the same key twice, nothing will come of it.
 * If you need a second instance of an object, give it another key.
 *
 * @package     cake
 * @subpackage  cake.cake.libs
 */
class ClassRegistry {
/**
 * Names of classes with their objects.
 *
 * @var array
 * @access private
 */
    var $__objects = array();
/**
 * Names of class names mapped to the object in the registry.
 *
 * @var array
 * @access private
 */
    var $__map = array();
/**
 * Return a singleton instance of the ClassRegistry.
 *
 * @return ClassRegistry instance
 * @access public
 */
    function &getInstance() {
        static $instance = array();
        if (!$instance) {
            $instance[0] =& new ClassRegistry();
        }
        return $instance[0];
    }
/**
 * Loads a class, registers the object in the registry and returns instance of the object.
 *
 *
 * @param mixed $class as a string or a single key => value array instance will be created, stored in the registry and returned.
 *   Required: array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry', 'type' => 'TypeOfClass');
 *   Model Classes can accept optional array('id' => $id, 'table' => $table, 'ds' => $ds, 'alias' => $alias);
 * When $class is a numeric keyed array, multiple class instances will be stored in the registry, no instance of the object will be returned
 *   array(
 *  array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry', 'type' => 'TypeOfClass'),
 *  array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry', 'type' => 'TypeOfClass'),
 *  array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry', 'type' => 'TypeOfClass'));
 *
 * @param string $type TypeOfClass
 * @return object intance of ClassName
 */
    function &init($class, $type = null) {
        $_this =& ClassRegistry::getInstance();
        $id = $false = false;
        $table = $ds = $alias = $plugin = null;
        $options = null;
        $true = true;
        if (!$type) {
            $type = 'Model';
        }

        if (is_array($class)) {
            $objects = $class;
            if (!isset($class[0])) {
                $objects = array($class);
            }
        } else {
            $objects = array(array('class' => $class));
        }

        $count = count($objects);
        foreach ($objects as $key => $settings) {
            if (is_array($settings)) {
                $plugin = null;
                $settings = array_merge(array('id' => false, 'table' => null, 'ds' => null, 'alias' => null, 'name' => null), $settings);

                extract($settings, EXTR_OVERWRITE);

                if (strpos($class, '.') !== false) {
                    list($plugin, $class) = explode('.', $class);
                    $plugin = $plugin . '.';
                }

                if (empty($alias)) {
                    $alias = $class;
                }

                if ($_this->_duplicate($alias, $class) && $count == 1) {
                    $_this->map($alias, $class);
                    return $_this->getObject($alias);
                }

                if ($type === 'Model') {
                    $options = array('id' => $id, 'table' => $table, 'ds' => $ds, 'alias' => $alias, 'name' => $class);
                }
                if (App::import($type, $plugin . $class)) {
                    ${$class} =& new $class($options);
                } elseif ($type === 'Model') {
                    if ($plugin && class_exists($plugin .'AppModel')) {
                        $appModel = $plugin .'AppModel';
                    } else {
                        $appModel = 'AppModel';
                    }
                    ${$class} =& new $appModel($options);
                }

                if (!isset(${$class})) {
                    trigger_error(sprintf(__('(ClassRegistry::init() could not create instance of %1$s class %2$s ', true), $class, $type), E_USER_WARNING);
                    return $false;
                }

                if ($type !== 'Model') {
                    $_this->addObject($alias, ${$class});
                } else {
                    $_this->map($alias, $class);
                }
            } elseif (is_numeric($settings)) {
                trigger_error(__('(ClassRegistry::init() Attempted to create instance of a class with a numeric name', true), E_USER_WARNING);
                return $false;
            }
        }

        if ($count > 1) {
            return $true;
        }

        return ${$class};
    }
/**
 * Add $object to the registry, associating it with the name $key.
 *
 * @param string $key   Key for the object in registry
 * @param mixed $object Object to store
 * @return boolean True if the object was written, false if $key already exists
 * @access public
 */
    function addObject($key, &$object) {
        $_this =& ClassRegistry::getInstance();
        $key = Inflector::underscore($key);
        if (array_key_exists($key, $_this->__objects) === false) {
            $_this->__objects[$key] = &$object;
            return true;
        }
        return false;
    }
/**
 * Remove object which corresponds to given key.
 *
 * @param string $key   Key of object to remove from registry
 * @access public
 */
    function removeObject($key) {
        $_this =& ClassRegistry::getInstance();
        $key = Inflector::underscore($key);
        if (array_key_exists($key, $_this->__objects) === true) {
            unset($_this->__objects[$key]);
        }
    }
/**
 * Returns true if given key is present in the ClassRegistry.
 *
 * @param string $key Key to look for
 * @return boolean true if key exists in registry, false otherwise
 * @access public
 */
    function isKeySet($key) {
        $_this =& ClassRegistry::getInstance();
        $key = Inflector::underscore($key);
        if (array_key_exists($key, $_this->__objects)) {
            return true;
        } elseif (array_key_exists($key, $_this->__map)) {
            return true;
        }
        return false;
    }
/**
 * Get all keys from the regisrty.
 *
 * @return array Set of keys stored in registry
 * @access public
 */
    function keys() {
        $_this =& ClassRegistry::getInstance();
        return array_keys($_this->__objects);
    }
/**
 * Return object which corresponds to given key.
 *
 * @param string $key Key of object to look for
 * @return mixed Object stored in registry
 * @access public
 */
    function &getObject($key) {
        $_this =& ClassRegistry::getInstance();
        $key = Inflector::underscore($key);

        if (isset($_this->__objects[$key])) {
            return $_this->__objects[$key];
        } else {
            $key = $_this->__getMap($key);
            if (isset($_this->__objects[$key])) {
                return $_this->__objects[$key];
            }
        }

        $return = false;
        return $return;
    }
/**
 * Checks to see if $alias is a duplicate $class Object
 *
 * @param string $alias
 * @param string $class
 * @return boolean
 */
    function _duplicate($alias,  $class) {
        $_this =& ClassRegistry::getInstance();
        $duplicate = false;

        if ($_this->isKeySet($alias)) {
            $model = $_this->getObject($alias);
            if (is_a($model, $class)) {
                $duplicate = true;
            }
            unset($model);
        }
        return $duplicate;
    }
/**
 * Add a key name pair to the registry to map name to class in the regisrty.
 *
 * @param string $key Key to include in map
 * @param string $name Key that is being mapped
 * @access public
 */
    function map($key, $name) {
        $_this =& ClassRegistry::getInstance();
        $key = Inflector::underscore($key);
        $name = Inflector::underscore($name);
        if (array_key_exists($key, $_this->__map) === false) {
            $_this->__map[$key] = $name;
        }
    }
/**
 * Get all keys from the map in the regisrty.
 *
 * @return array Keys of registry's map
 * @access public
 */
    function mapKeys() {
        $_this =& ClassRegistry::getInstance();
        return array_keys($_this->__map);
    }
/**
 * Return the name of a class in the registry.
 *
 * @param string $key Key to find in map
 * @return string Mapped value
 * @access private
 */
    function __getMap($key) {
        $_this =& ClassRegistry::getInstance();
        if (array_key_exists($key, $_this->__map)) {
            return $_this->__map[$key];
        }
    }
/**
 * Flushes all objects from the ClassRegistry.
 *
 * @access public
 */
    function flush() {
        $_this =& ClassRegistry::getInstance();
        $_this->__objects = array();
        $_this->__map = array();
    }
}
?>

© 2007 Cake Software Foundation