RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-02-21 14:43:14 +03:00
Code Issues Projects Releases Wiki Activity

Fixed Ticket #561. Typo.

Browse Source
This commit is contained in:
phuson 2007-11-02 16:59:20 +00:00
parent 79e52571aa
commit c6f53114a3
1 changed files with 412 additions and 412 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

824
lib/Doctrine/Configurable.php
View File

@ -1,412 +1,412 @@
<?php <?php
/* /*
* $Id$ * $Id$
* *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
* This software consists of voluntary contributions made by many individuals * This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see * and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>. * <http://www.phpdoctrine.com>.
*/ */
/** /**
* Doctrine_Configurable * Doctrine_Configurable
* the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection * the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection
* *
* *
* @package Doctrine * @package Doctrine
* @subpackage Configurable * @subpackage Configurable
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.phpdoctrine.com * @link www.phpdoctrine.com
* @since 1.0 * @since 1.0
* @version $Revision$ * @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi> * @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/ */
abstract class Doctrine_Configurable extends Doctrine_Locator_Injectable abstract class Doctrine_Configurable extends Doctrine_Locator_Injectable
{ {
/** /**
* @var array $attributes an array of containing all attributes * @var array $attributes an array of containing all attributes
*/ */
protected $attributes = array(); protected $attributes = array();
/** /**
* @var Doctrine_Configurable $parent the parent of this component * @var Doctrine_Configurable $parent the parent of this component
*/ */
protected $parent; protected $parent;
/** /**
* @var array $_impl an array containing concrete implementations for class templates * @var array $_impl an array containing concrete implementations for class templates
* keys as template names and values as names of the concrete * keys as template names and values as names of the concrete
* implementation classes * implementation classes
*/ */
protected $_impl = array(); protected $_impl = array();
/** /**
* @var array $_params an array of user defined parameters * @var array $_params an array of user defined parameters
*/ */
protected $_params = array(); protected $_params = array();
/** /**
* setAttribute * setAttribute
* sets a given attribute * sets a given attribute
* *
* <code> * <code>
* $manager->setAttribute(Doctrine::ATTR_PORTABILITY, Doctrine::PORTABILITY_ALL); * $manager->setAttribute(Doctrine::ATTR_PORTABILITY, Doctrine::PORTABILITY_ALL);
* *
* // or * // or
* *
* $manager->setAttribute('portability', Doctrine::PORTABILITY_ALL); * $manager->setAttribute('portability', Doctrine::PORTABILITY_ALL);
* </code> * </code>
* *
* @param mixed $attribute either a Doctrine::ATTR_* integer constant or a string * @param mixed $attribute either a Doctrine::ATTR_* integer constant or a string
* corresponding to a constant * corresponding to a constant
* @param mixed $value the value of the attribute * @param mixed $value the value of the attribute
* @see Doctrine::ATTR_* constants * @see Doctrine::ATTR_* constants
* @throws Doctrine_Exception if the value is invalid * @throws Doctrine_Exception if the value is invalid
* @return void * @return void
*/ */
public function setAttribute($attribute,$value) public function setAttribute($attribute,$value)
{ {
if (is_string($attribute)) { if (is_string($attribute)) {
$upper = strtoupper($attribute); $upper = strtoupper($attribute);
$const = 'Doctrine::ATTR_' . $attribute; $const = 'Doctrine::ATTR_' . $attribute;
if (defined($const)) { if (defined($const)) {
$this->_state = constant($const); $this->_state = constant($const);
} else { } else {
throw new Doctrine_Exception('Unknown attribute ' . $attribute); throw new Doctrine_Exception('Unknown attribute ' . $attribute);
} }
} }
switch ($attribute) { switch ($attribute) {
case Doctrine::ATTR_FETCHMODE: case Doctrine::ATTR_FETCHMODE:
throw new Doctrine_Exception('Deprecated attribute. See http://doctrine.pengus.net/doctrine/manual/new/?chapter=configuration'); throw new Doctrine_Exception('Deprecated attribute. See http://doctrine.pengus.net/doctrine/manual/new/?chapter=configuration');
case Doctrine::ATTR_LISTENER: case Doctrine::ATTR_LISTENER:
$this->setEventListener($value); $this->setEventListener($value);
break; break;
case Doctrine::ATTR_COLL_KEY: case Doctrine::ATTR_COLL_KEY:
if ( ! ($this instanceof Doctrine_Table)) { if ( ! ($this instanceof Doctrine_Table)) {
throw new Doctrine_Exception("This attribute can only be set at table level."); throw new Doctrine_Exception("This attribute can only be set at table level.");
} }
if ($value !== null && ! $this->hasColumn($value)) { if ($value !== null && ! $this->hasColumn($value)) {
throw new Doctrine_Exception("Couldn't set collection key attribute. No such column '$value'"); throw new Doctrine_Exception("Couldn't set collection key attribute. No such column '$value'");
} }
break; break;
case Doctrine::ATTR_CACHE: case Doctrine::ATTR_CACHE:
if ($value !== null) { if ($value !== null) {
if ( ! ($value instanceof Doctrine_Cache_Interface)) { if ( ! ($value instanceof Doctrine_Cache_Interface)) {
throw new Doctrine_Exception('Cache driver should implement Doctrine_Cache_Interface'); throw new Doctrine_Exception('Cache driver should implement Doctrine_Cache_Interface');
} }
} }
break; break;
case Doctrine::ATTR_VALIDATE: case Doctrine::ATTR_VALIDATE:
case Doctrine::ATTR_QUERY_LIMIT: case Doctrine::ATTR_QUERY_LIMIT:
case Doctrine::ATTR_QUOTE_IDENTIFIER: case Doctrine::ATTR_QUOTE_IDENTIFIER:
case Doctrine::ATTR_PORTABILITY: case Doctrine::ATTR_PORTABILITY:
case Doctrine::ATTR_DEFAULT_TABLE_TYPE: case Doctrine::ATTR_DEFAULT_TABLE_TYPE:
case Doctrine::ATTR_EMULATE_DATABASE: case Doctrine::ATTR_EMULATE_DATABASE:
case Doctrine::ATTR_USE_NATIVE_ENUM: case Doctrine::ATTR_USE_NATIVE_ENUM:
case Doctrine::ATTR_DEFAULT_SEQUENCE: case Doctrine::ATTR_DEFAULT_SEQUENCE:
case Doctrine::ATTR_EXPORT: case Doctrine::ATTR_EXPORT:
case Doctrine::ATTR_DECIMAL_PLACES: case Doctrine::ATTR_DECIMAL_PLACES:
case Doctrine::ATTR_LOAD_REFERENCES: case Doctrine::ATTR_LOAD_REFERENCES:
case Doctrine::ATTR_RECORD_LISTENER: case Doctrine::ATTR_RECORD_LISTENER:
case Doctrine::ATTR_THROW_EXCEPTIONS: case Doctrine::ATTR_THROW_EXCEPTIONS:
case Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE: case Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE:
break; break;
case Doctrine::ATTR_SEQCOL_NAME: case Doctrine::ATTR_SEQCOL_NAME:
if ( ! is_string($value)) { if ( ! is_string($value)) {
throw new Doctrine_Exception('Sequence column name attribute only accepts string values'); throw new Doctrine_Exception('Sequence column name attribute only accepts string values');
} }
break; break;
case Doctrine::ATTR_FIELD_CASE: case Doctrine::ATTR_FIELD_CASE:
if ($value != 0 && $value != CASE_LOWER && $value != CASE_UPPER) if ($value != 0 && $value != CASE_LOWER && $value != CASE_UPPER)
throw new Doctrine_Exception('Field case attribute should be either 0, CASE_LOWER or CASE_UPPER constant.'); throw new Doctrine_Exception('Field case attribute should be either 0, CASE_LOWER or CASE_UPPER constant.');
break; break;
case Doctrine::ATTR_SEQNAME_FORMAT: case Doctrine::ATTR_SEQNAME_FORMAT:
case Doctrine::ATTR_IDXNAME_FORMAT: case Doctrine::ATTR_IDXNAME_FORMAT:
case Doctrine::ATTR_TBLNAME_FORMAT: case Doctrine::ATTR_TBLNAME_FORMAT:
if ($this instanceof Doctrine_Table) { if ($this instanceof Doctrine_Table) {
throw new Doctrine_Exception('Sequence / index name format attributes cannot be set' throw new Doctrine_Exception('Sequence / index name format attributes cannot be set'
. 'at table level (only at connection or global level).'); . 'at table level (only at connection or global level).');
} }
break; break;
default: default:
throw new Doctrine_Exception("Unknown attribute."); throw new Doctrine_Exception("Unknown attribute.");
} }
$this->attributes[$attribute] = $value; $this->attributes[$attribute] = $value;
} }
public function getParams($namespace = null) public function getParams($namespace = null)
{ {
if ($namespace = null) { if ($namespace == null) {
$namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE); $namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE);
} }
if ( ! isset($this->_params[$namespace])) { if ( ! isset($this->_params[$namespace])) {
return null; return null;
} }
return $this->_params[$namespace]; return $this->_params[$namespace];
} }
public function getParamNamespaces() public function getParamNamespaces()
{ {
return array_keys($this->_params); return array_keys($this->_params);
} }
public function setParam($name, $value, $namespace = null) public function setParam($name, $value, $namespace = null)
{ {
if ($namespace = null) { if ($namespace == null) {
$namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE); $namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE);
} }
$this->_params[$namespace][$name] = $value; $this->_params[$namespace][$name] = $value;
return $this; return $this;
} }
public function getParam($name, $value, $namespace) public function getParam($name, $value, $namespace)
{ {
if ($namespace = null) { if ($namespace == null) {
$namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE); $namespace = $this->getAttribute(Doctrine::ATTR_DEFAULT_PARAM_NAMESPACE);
} }
if ( ! isset($this->_params[$name])) { if ( ! isset($this->_params[$name])) {
if (isset($this->parent)) { if (isset($this->parent)) {
return $this->parent->getParam($name); return $this->parent->getParam($name);
} }
return null; return null;
} }
return $this->_params[$name]; return $this->_params[$name];
} }
/** /**
* setImpl * setImpl
* binds given class to given template name * binds given class to given template name
* *
* this method is the base of Doctrine dependency injection * this method is the base of Doctrine dependency injection
* *
* @param string $template name of the class template * @param string $template name of the class template
* @param string $class name of the class to be bound * @param string $class name of the class to be bound
* @return Doctrine_Configurable this object * @return Doctrine_Configurable this object
*/ */
public function setImpl($template, $class) public function setImpl($template, $class)
{ {
$this->_impl[$template] = $class; $this->_impl[$template] = $class;
return $this; return $this;
} }
/** /**
* getImpl * getImpl
* returns the implementation for given class * returns the implementation for given class
* *
* @return string name of the concrete implementation * @return string name of the concrete implementation
*/ */
public function getImpl($template) public function getImpl($template)
{ {
if ( ! isset($this->_impl[$template])) { if ( ! isset($this->_impl[$template])) {
if (isset($this->parent)) { if (isset($this->parent)) {
return $this->parent->getImpl($template); return $this->parent->getImpl($template);
} }
return null; return null;
} }
return $this->_impl[$template]; return $this->_impl[$template];
} }
/** /**
* getCacheDriver * getCacheDriver
* *
* @return Doctrine_Cache_Interface * @return Doctrine_Cache_Interface
*/ */
public function getCacheDriver() public function getCacheDriver()
{ {
if ( ! isset($this->attributes[Doctrine::ATTR_CACHE])) { if ( ! isset($this->attributes[Doctrine::ATTR_CACHE])) {
throw new Doctrine_Exception('Cache driver not initialized.'); throw new Doctrine_Exception('Cache driver not initialized.');
} }
return $this->attributes[Doctrine::ATTR_CACHE]; return $this->attributes[Doctrine::ATTR_CACHE];
} }
/** /**
* @param Doctrine_EventListener $listener * @param Doctrine_EventListener $listener
* @return void * @return void
*/ */
public function setEventListener($listener) public function setEventListener($listener)
{ {
return $this->setListener($listener); return $this->setListener($listener);
} }
/** /**
* addRecordListener * addRecordListener
* *
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
* @return mixed this object * @return mixed this object
*/ */
public function addRecordListener($listener, $name = null) public function addRecordListener($listener, $name = null)
{ {
if ( ! isset($this->attributes[Doctrine::ATTR_RECORD_LISTENER]) || if ( ! isset($this->attributes[Doctrine::ATTR_RECORD_LISTENER]) ||
! ($this->attributes[Doctrine::ATTR_RECORD_LISTENER] instanceof Doctrine_Record_Listener_Chain)) { ! ($this->attributes[Doctrine::ATTR_RECORD_LISTENER] instanceof Doctrine_Record_Listener_Chain)) {
$this->attributes[Doctrine::ATTR_RECORD_LISTENER] = new Doctrine_Record_Listener_Chain(); $this->attributes[Doctrine::ATTR_RECORD_LISTENER] = new Doctrine_Record_Listener_Chain();
} }
$this->attributes[Doctrine::ATTR_RECORD_LISTENER]->add($listener, $name); $this->attributes[Doctrine::ATTR_RECORD_LISTENER]->add($listener, $name);
return $this; return $this;
} }
/** /**
* getListener * getListener
* *
* @return Doctrine_EventListener_Interface|Doctrine_Overloadable * @return Doctrine_EventListener_Interface|Doctrine_Overloadable
*/ */
public function getRecordListener() public function getRecordListener()
{ {
if ( ! isset($this->attributes[Doctrine::ATTR_RECORD_LISTENER])) { if ( ! isset($this->attributes[Doctrine::ATTR_RECORD_LISTENER])) {
if (isset($this->parent)) { if (isset($this->parent)) {
return $this->parent->getRecordListener(); return $this->parent->getRecordListener();
} }
return null; return null;
} }
return $this->attributes[Doctrine::ATTR_RECORD_LISTENER]; return $this->attributes[Doctrine::ATTR_RECORD_LISTENER];
} }
/** /**
* setListener * setListener
* *
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
* @return Doctrine_Configurable this object * @return Doctrine_Configurable this object
*/ */
public function setRecordListener($listener) public function setRecordListener($listener)
{ {
if ( ! ($listener instanceof Doctrine_Record_Listener_Interface) if ( ! ($listener instanceof Doctrine_Record_Listener_Interface)
&& ! ($listener instanceof Doctrine_Overloadable) && ! ($listener instanceof Doctrine_Overloadable)
) { ) {
throw new Doctrine_Exception("Couldn't set eventlistener. Record listeners should implement either Doctrine_Record_Listener_Interface or Doctrine_Overloadable"); throw new Doctrine_Exception("Couldn't set eventlistener. Record listeners should implement either Doctrine_Record_Listener_Interface or Doctrine_Overloadable");
} }
$this->attributes[Doctrine::ATTR_RECORD_LISTENER] = $listener; $this->attributes[Doctrine::ATTR_RECORD_LISTENER] = $listener;
return $this; return $this;
} }
/** /**
* addListener * addListener
* *
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
* @return mixed this object * @return mixed this object
*/ */
public function addListener($listener, $name = null) public function addListener($listener, $name = null)
{ {
if ( ! isset($this->attributes[Doctrine::ATTR_LISTENER]) || if ( ! isset($this->attributes[Doctrine::ATTR_LISTENER]) ||
! ($this->attributes[Doctrine::ATTR_LISTENER] instanceof Doctrine_EventListener_Chain)) { ! ($this->attributes[Doctrine::ATTR_LISTENER] instanceof Doctrine_EventListener_Chain)) {
$this->attributes[Doctrine::ATTR_LISTENER] = new Doctrine_EventListener_Chain(); $this->attributes[Doctrine::ATTR_LISTENER] = new Doctrine_EventListener_Chain();
} }
$this->attributes[Doctrine::ATTR_LISTENER]->add($listener, $name); $this->attributes[Doctrine::ATTR_LISTENER]->add($listener, $name);
return $this; return $this;
} }
/** /**
* getListener * getListener
* *
* @return Doctrine_EventListener_Interface|Doctrine_Overloadable * @return Doctrine_EventListener_Interface|Doctrine_Overloadable
*/ */
public function getListener() public function getListener()
{ {
if ( ! isset($this->attributes[Doctrine::ATTR_LISTENER])) { if ( ! isset($this->attributes[Doctrine::ATTR_LISTENER])) {
if (isset($this->parent)) { if (isset($this->parent)) {
return $this->parent->getListener(); return $this->parent->getListener();
} }
return null; return null;
} }
return $this->attributes[Doctrine::ATTR_LISTENER]; return $this->attributes[Doctrine::ATTR_LISTENER];
} }
/** /**
* setListener * setListener
* *
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
* @return Doctrine_Configurable this object * @return Doctrine_Configurable this object
*/ */
public function setListener($listener) public function setListener($listener)
{ {
if ( ! ($listener instanceof Doctrine_EventListener_Interface) if ( ! ($listener instanceof Doctrine_EventListener_Interface)
&& ! ($listener instanceof Doctrine_Overloadable) && ! ($listener instanceof Doctrine_Overloadable)
) { ) {
throw new Doctrine_EventListener_Exception("Couldn't set eventlistener. EventListeners should implement either Doctrine_EventListener_Interface or Doctrine_Overloadable"); throw new Doctrine_EventListener_Exception("Couldn't set eventlistener. EventListeners should implement either Doctrine_EventListener_Interface or Doctrine_Overloadable");
} }
$this->attributes[Doctrine::ATTR_LISTENER] = $listener; $this->attributes[Doctrine::ATTR_LISTENER] = $listener;
return $this; return $this;
} }
/** /**
* returns the value of an attribute * returns the value of an attribute
* *
* @param integer $attribute * @param integer $attribute
* @return mixed * @return mixed
*/ */
public function getAttribute($attribute) public function getAttribute($attribute)
{ {
$attribute = (int) $attribute; $attribute = (int) $attribute;
if ($attribute < 0) { if ($attribute < 0) {
throw new Doctrine_Exception('Unknown attribute.'); throw new Doctrine_Exception('Unknown attribute.');
} }
if ( ! isset($this->attributes[$attribute])) { if ( ! isset($this->attributes[$attribute])) {
if (isset($this->parent)) { if (isset($this->parent)) {
return $this->parent->getAttribute($attribute); return $this->parent->getAttribute($attribute);
} }
return null; return null;
} }
return $this->attributes[$attribute]; return $this->attributes[$attribute];
} }
/** /**
* getAttributes * getAttributes
* returns all attributes as an array * returns all attributes as an array
* *
* @return array * @return array
*/ */
public function getAttributes() public function getAttributes()
{ {
return $this->attributes; return $this->attributes;
} }
/** /**
* sets a parent for this configurable component * sets a parent for this configurable component
* the parent must be configurable component itself * the parent must be configurable component itself
* *
* @param Doctrine_Configurable $component * @param Doctrine_Configurable $component
* @return void * @return void
*/ */
public function setParent(Doctrine_Configurable $component) public function setParent(Doctrine_Configurable $component)
{ {
$this->parent = $component; $this->parent = $component;
} }
/** /**
* getParent * getParent
* returns the parent of this component * returns the parent of this component
* *
* @return Doctrine_Configurable * @return Doctrine_Configurable
*/ */
public function getParent() public function getParent()
{ {
return $this->parent; return $this->parent;
} }
} }