427 lines
13 KiB
PHP
427 lines
13 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
* $Id: Configurable.php 7490 2010-03-29 19:53:27Z jwage $
|
||
|
|
*
|
||
|
|
* 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
|
||
|
|
* OWNER 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.
|
||
|
|
*
|
||
|
|
* This software consists of voluntary contributions made by many individuals
|
||
|
|
* and is licensed under the LGPL. For more information, see
|
||
|
|
* <http://www.doctrine-project.org>.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Doctrine_Configurable
|
||
|
|
* the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection
|
||
|
|
*
|
||
|
|
* @package Doctrine
|
||
|
|
* @subpackage Configurable
|
||
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
||
|
|
* @link www.doctrine-project.org
|
||
|
|
* @since 1.0
|
||
|
|
* @version $Revision: 7490 $
|
||
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
||
|
|
*/
|
||
|
|
abstract class Doctrine_Configurable extends Doctrine_Locator_Injectable
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @var array $attributes an array of containing all attributes
|
||
|
|
*/
|
||
|
|
protected $attributes = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var Doctrine_Configurable $parent the parent of this component
|
||
|
|
*/
|
||
|
|
protected $parent;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var array $_impl an array containing concrete implementations for class templates
|
||
|
|
* keys as template names and values as names of the concrete
|
||
|
|
* implementation classes
|
||
|
|
*/
|
||
|
|
protected $_impl = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var array $_params an array of user defined parameters
|
||
|
|
*/
|
||
|
|
protected $_params = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* setAttribute
|
||
|
|
* sets a given attribute
|
||
|
|
*
|
||
|
|
* <code>
|
||
|
|
* $manager->setAttribute(Doctrine_Core::ATTR_PORTABILITY, Doctrine_Core::PORTABILITY_ALL);
|
||
|
|
* </code>
|
||
|
|
*
|
||
|
|
* @param mixed $attribute either a Doctrine_Core::ATTR_* integer constant or a string
|
||
|
|
* corresponding to a constant
|
||
|
|
* @param mixed $value the value of the attribute
|
||
|
|
* @see Doctrine_Core::ATTR_* constants
|
||
|
|
* @throws Doctrine_Exception if the value is invalid
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setAttribute($attribute, $value)
|
||
|
|
{
|
||
|
|
switch ($attribute) {
|
||
|
|
case Doctrine_Core::ATTR_LISTENER:
|
||
|
|
$this->setEventListener($value);
|
||
|
|
break;
|
||
|
|
case Doctrine_Core::ATTR_COLL_KEY:
|
||
|
|
if ( ! ($this instanceof Doctrine_Table)) {
|
||
|
|
throw new Doctrine_Exception("This attribute can only be set at table level.");
|
||
|
|
}
|
||
|
|
if ($value !== null && ! $this->hasField($value)) {
|
||
|
|
throw new Doctrine_Exception("Couldn't set collection key attribute. No such field '$value'.");
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
case Doctrine_Core::ATTR_CACHE:
|
||
|
|
case Doctrine_Core::ATTR_RESULT_CACHE:
|
||
|
|
case Doctrine_Core::ATTR_QUERY_CACHE:
|
||
|
|
if ($value !== null) {
|
||
|
|
if ( ! ($value instanceof Doctrine_Cache_Interface)) {
|
||
|
|
throw new Doctrine_Exception('Cache driver should implement Doctrine_Cache_Interface');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
case Doctrine_Core::ATTR_SEQCOL_NAME:
|
||
|
|
if ( ! is_string($value)) {
|
||
|
|
throw new Doctrine_Exception('Sequence column name attribute only accepts string values');
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
case Doctrine_Core::ATTR_FIELD_CASE:
|
||
|
|
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.');
|
||
|
|
break;
|
||
|
|
case Doctrine_Core::ATTR_SEQNAME_FORMAT:
|
||
|
|
case Doctrine_Core::ATTR_IDXNAME_FORMAT:
|
||
|
|
case Doctrine_Core::ATTR_TBLNAME_FORMAT:
|
||
|
|
case Doctrine_Core::ATTR_FKNAME_FORMAT:
|
||
|
|
if ($this instanceof Doctrine_Table) {
|
||
|
|
throw new Doctrine_Exception('Sequence / index name format attributes cannot be set'
|
||
|
|
. 'at table level (only at connection or global level).');
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->attributes[$attribute] = $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getParams($namespace = null)
|
||
|
|
{
|
||
|
|
if ($namespace == null) {
|
||
|
|
$namespace = $this->getAttribute(Doctrine_Core::ATTR_DEFAULT_PARAM_NAMESPACE);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset($this->_params[$namespace])) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->_params[$namespace];
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getParamNamespaces()
|
||
|
|
{
|
||
|
|
return array_keys($this->_params);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function setParam($name, $value, $namespace = null)
|
||
|
|
{
|
||
|
|
if ($namespace == null) {
|
||
|
|
$namespace = $this->getAttribute(Doctrine_Core::ATTR_DEFAULT_PARAM_NAMESPACE);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->_params[$namespace][$name] = $value;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getParam($name, $namespace = null)
|
||
|
|
{
|
||
|
|
if ($namespace == null) {
|
||
|
|
$namespace = $this->getAttribute(Doctrine_Core::ATTR_DEFAULT_PARAM_NAMESPACE);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset($this->_params[$namespace][$name])) {
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->getParam($name, $namespace);
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->_params[$namespace][$name];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* setImpl
|
||
|
|
* binds given class to given template name
|
||
|
|
*
|
||
|
|
* this method is the base of Doctrine dependency injection
|
||
|
|
*
|
||
|
|
* @param string $template name of the class template
|
||
|
|
* @param string $class name of the class to be bound
|
||
|
|
* @return Doctrine_Configurable this object
|
||
|
|
*/
|
||
|
|
public function setImpl($template, $class)
|
||
|
|
{
|
||
|
|
$this->_impl[$template] = $class;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* getImpl
|
||
|
|
* returns the implementation for given class
|
||
|
|
*
|
||
|
|
* @return string name of the concrete implementation
|
||
|
|
*/
|
||
|
|
public function getImpl($template)
|
||
|
|
{
|
||
|
|
if ( ! isset($this->_impl[$template])) {
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->getImpl($template);
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
return $this->_impl[$template];
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
public function hasImpl($template)
|
||
|
|
{
|
||
|
|
if ( ! isset($this->_impl[$template])) {
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->hasImpl($template);
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param Doctrine_EventListener $listener
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setEventListener($listener)
|
||
|
|
{
|
||
|
|
return $this->setListener($listener);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* addRecordListener
|
||
|
|
*
|
||
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
||
|
|
* @return Doctrine_Configurable this object
|
||
|
|
*/
|
||
|
|
public function addRecordListener($listener, $name = null)
|
||
|
|
{
|
||
|
|
if ( ! isset($this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER]) ||
|
||
|
|
! ($this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER] instanceof Doctrine_Record_Listener_Chain)) {
|
||
|
|
|
||
|
|
$this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER] = new Doctrine_Record_Listener_Chain();
|
||
|
|
}
|
||
|
|
$this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER]->add($listener, $name);
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* getListener
|
||
|
|
*
|
||
|
|
* @return Doctrine_EventListener_Interface|Doctrine_Overloadable
|
||
|
|
*/
|
||
|
|
public function getRecordListener()
|
||
|
|
{
|
||
|
|
if ( ! isset($this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER])) {
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->getRecordListener();
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
return $this->attributes[Doctrine_Core::ATTR_RECORD_LISTENER];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* setListener
|
||
|
|
*
|
||
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
||
|
|
* @return Doctrine_Configurable this object
|
||
|
|
*/
|
||
|
|
public function setRecordListener($listener)
|
||
|
|
{
|
||
|
|
if ( ! ($listener instanceof Doctrine_Record_Listener_Interface)
|
||
|
|
&& ! ($listener instanceof 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_Core::ATTR_RECORD_LISTENER] = $listener;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* addListener
|
||
|
|
*
|
||
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
||
|
|
* @return Doctrine_Configurable this object
|
||
|
|
*/
|
||
|
|
public function addListener($listener, $name = null)
|
||
|
|
{
|
||
|
|
if ( ! isset($this->attributes[Doctrine_Core::ATTR_LISTENER]) ||
|
||
|
|
! ($this->attributes[Doctrine_Core::ATTR_LISTENER] instanceof Doctrine_EventListener_Chain)) {
|
||
|
|
|
||
|
|
$this->attributes[Doctrine_Core::ATTR_LISTENER] = new Doctrine_EventListener_Chain();
|
||
|
|
}
|
||
|
|
$this->attributes[Doctrine_Core::ATTR_LISTENER]->add($listener, $name);
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* getListener
|
||
|
|
*
|
||
|
|
* @return Doctrine_EventListener_Interface|Doctrine_Overloadable
|
||
|
|
*/
|
||
|
|
public function getListener()
|
||
|
|
{
|
||
|
|
if ( ! isset($this->attributes[Doctrine_Core::ATTR_LISTENER])) {
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->getListener();
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
return $this->attributes[Doctrine_Core::ATTR_LISTENER];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* setListener
|
||
|
|
*
|
||
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
||
|
|
* @return Doctrine_Configurable this object
|
||
|
|
*/
|
||
|
|
public function setListener($listener)
|
||
|
|
{
|
||
|
|
if ( ! ($listener instanceof Doctrine_EventListener_Interface)
|
||
|
|
&& ! ($listener instanceof Doctrine_Overloadable)
|
||
|
|
) {
|
||
|
|
throw new Doctrine_EventListener_Exception("Couldn't set eventlistener. EventListeners should implement either Doctrine_EventListener_Interface or Doctrine_Overloadable");
|
||
|
|
}
|
||
|
|
$this->attributes[Doctrine_Core::ATTR_LISTENER] = $listener;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* returns the value of an attribute
|
||
|
|
*
|
||
|
|
* @param integer $attribute
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function getAttribute($attribute)
|
||
|
|
{
|
||
|
|
if (isset($this->attributes[$attribute])) {
|
||
|
|
return $this->attributes[$attribute];
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($this->parent)) {
|
||
|
|
return $this->parent->getAttribute($attribute);
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Unset an attribute from this levels attributes
|
||
|
|
*
|
||
|
|
* @param integer $attribute
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function unsetAttribute($attribute)
|
||
|
|
{
|
||
|
|
if (isset($this->attributes[$attribute])) {
|
||
|
|
unset($this->attributes[$attribute]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* getAttributes
|
||
|
|
* returns all attributes as an array
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getAttributes()
|
||
|
|
{
|
||
|
|
return $this->attributes;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the charset
|
||
|
|
*
|
||
|
|
* @param string $charset
|
||
|
|
*/
|
||
|
|
public function setCharset($charset)
|
||
|
|
{
|
||
|
|
$this->setAttribute(Doctrine_Core::ATTR_DEFAULT_TABLE_CHARSET, $charset);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the charset
|
||
|
|
*
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function getCharset()
|
||
|
|
{
|
||
|
|
return $this->getAttribute(Doctrine_Core::ATTR_DEFAULT_TABLE_CHARSET);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the collate
|
||
|
|
*
|
||
|
|
* @param string $collate
|
||
|
|
*/
|
||
|
|
public function setCollate($collate)
|
||
|
|
{
|
||
|
|
$this->setAttribute(Doctrine_Core::ATTR_DEFAULT_TABLE_COLLATE, $collate);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the collate
|
||
|
|
*
|
||
|
|
* @return mixed $collate
|
||
|
|
*/
|
||
|
|
public function getCollate()
|
||
|
|
{
|
||
|
|
return $this->getAttribute(Doctrine_Core::ATTR_DEFAULT_TABLE_COLLATE);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* sets a parent for this configurable component
|
||
|
|
* the parent must be configurable component itself
|
||
|
|
*
|
||
|
|
* @param Doctrine_Configurable $component
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setParent(Doctrine_Configurable $component)
|
||
|
|
{
|
||
|
|
$this->parent = $component;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* getParent
|
||
|
|
* returns the parent of this component
|
||
|
|
*
|
||
|
|
* @return Doctrine_Configurable
|
||
|
|
*/
|
||
|
|
public function getParent()
|
||
|
|
{
|
||
|
|
return $this->parent;
|
||
|
|
}
|
||
|
|
}
|