cakephp2-php8/cake/libs/class_registry.php
phpnut 0c490af5b1 Adding fix for #2051
Adding additional methods to the ClassRegistry to set mappings to class names.
Added ClassRegistry::map() in the model to set mappings where needed

git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@4449 3807eeeb-6ff5-0310-8944-8be069107fe0
2007-02-05 04:53:31 +00:00

155 lines
No EOL
3.7 KiB
PHP

<?php
/* SVN FILE: $Id$ */
/**
* 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-2007, 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-2007, 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$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @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
*/
function &getInstance() {
static $instance = array();
if (!$instance) {
$instance[0] =& new ClassRegistry();
}
return $instance[0];
}
/**
* Add $object to the registry, associating it with the name $key.
*
* @param string $key
* @param mixed $object
*/
function addObject($key, &$object) {
$_this =& ClassRegistry::getInstance();
$key = Inflector::underscore($key);
if (array_key_exists($key, $_this->__objects) === false) {
$_this->__objects[$key] = &$object;
}
}
/**
* Remove object which corresponds to given key.
*
* @param string $key
* @return void
*/
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 Success
*/
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;
}
/**
* Return object which corresponds to given key.
*
* @param string $key
* @return mixed
*/
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;
}
/**
* Add a key name pair to the registry to map name to class in the regisrty.
*
* @param string $key
* @param string $name
* @return void
*/
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;
}
}
/**
* Return the name of a class in the registry.
*
* @param string $key
* @return string
*/
function __getMap($key){
$_this =& ClassRegistry::getInstance();
if (array_key_exists($key, $_this->__map)) {
return $_this->__map[$key];
}
}
}
?>