355 lines
10 KiB
PHP
355 lines
10 KiB
PHP
<?php
|
|
/*
|
|
* $Id$
|
|
*
|
|
* 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.phpdoctrine.org>.
|
|
*/
|
|
|
|
/**
|
|
* Doctrine_Record_Abstract
|
|
*
|
|
* @package Doctrine
|
|
* @subpackage Record
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.phpdoctrine.org
|
|
* @since 1.0
|
|
* @version $Revision$
|
|
*/
|
|
abstract class Doctrine_Record_Abstract extends Doctrine_Access
|
|
{
|
|
/**
|
|
* @param Doctrine_Table $_table reference to associated Doctrine_Table instance
|
|
*/
|
|
protected $_table;
|
|
|
|
public function setTableDefinition()
|
|
{
|
|
|
|
}
|
|
public function setUp()
|
|
{
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* getTable
|
|
* returns the associated table object
|
|
*
|
|
* @return Doctrine_Table the associated table object
|
|
*/
|
|
public function getTable()
|
|
{
|
|
return $this->_table;
|
|
}
|
|
|
|
/**
|
|
* addListener
|
|
*
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
|
* @return Doctrine_Record
|
|
*/
|
|
public function addListener($listener, $name = null)
|
|
{
|
|
$this->_table->addRecordListener($listener, $name);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* getListener
|
|
*
|
|
* @return Doctrine_EventListener_Interface|Doctrine_Overloadable
|
|
*/
|
|
public function getListener()
|
|
{
|
|
return $this->_table->getRecordListener();
|
|
}
|
|
|
|
/**
|
|
* setListener
|
|
*
|
|
* @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
|
|
* @return Doctrine_Record
|
|
*/
|
|
public function setListener($listener)
|
|
{
|
|
$this->_table->setRecordListener($listener);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* index
|
|
* defines or retrieves an index
|
|
* if the second parameter is set this method defines an index
|
|
* if not this method retrieves index named $name
|
|
*
|
|
* @param string $name the name of the index
|
|
* @param array $definition the definition array
|
|
* @return mixed
|
|
*/
|
|
public function index($name, array $definition = array())
|
|
{
|
|
if ( ! $definition) {
|
|
return $this->_table->getIndex($name);
|
|
} else {
|
|
return $this->_table->addIndex($name, $definition);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Specify an array of fields that are unique and will be validated as such
|
|
*
|
|
* @return void
|
|
*/
|
|
public function unique()
|
|
{
|
|
$args = func_get_args();
|
|
|
|
if (count($args) == 1) {
|
|
$fields = (array) $args[0];
|
|
} else if (count($args) > 1) {
|
|
$fields = $args;
|
|
} else {
|
|
throw new Doctrine_Record_Exception('You must specify the fields to make a unique constraint on.');
|
|
}
|
|
|
|
return $this->_table->unique($fields);
|
|
}
|
|
|
|
public function setAttribute($attr, $value)
|
|
{
|
|
$this->_table->setAttribute($attr, $value);
|
|
}
|
|
public function setTableName($tableName)
|
|
{
|
|
$this->_table->setTableName($tableName);
|
|
}
|
|
public function setInheritanceMap($map)
|
|
{
|
|
$this->_table->setOption('inheritanceMap', $map);
|
|
}
|
|
|
|
public function setSubclasses($map)
|
|
{
|
|
if (isset($map[get_class($this)])) {
|
|
// fix for #1621
|
|
$mapFieldNames = $map[get_class($this)];
|
|
$mapColumnNames = array();
|
|
|
|
foreach ($mapFieldNames as $fieldName => $val) {
|
|
$mapColumnNames[$this->getTable()->getColumnName($fieldName)] = $val;
|
|
}
|
|
|
|
$this->_table->setOption('inheritanceMap', $mapColumnNames);
|
|
return;
|
|
}
|
|
|
|
$this->_table->setOption('subclasses', array_keys($map));
|
|
}
|
|
|
|
/**
|
|
* attribute
|
|
* sets or retrieves an option
|
|
*
|
|
* @see Doctrine::ATTR_* constants availible attributes
|
|
* @param mixed $attr
|
|
* @param mixed $value
|
|
* @return mixed
|
|
*/
|
|
public function attribute($attr, $value)
|
|
{
|
|
if ($value == null) {
|
|
if (is_array($attr)) {
|
|
foreach ($attr as $k => $v) {
|
|
$this->_table->setAttribute($k, $v);
|
|
}
|
|
} else {
|
|
return $this->_table->getAttribute($attr);
|
|
}
|
|
} else {
|
|
$this->_table->setAttribute($attr, $value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* option
|
|
* sets or retrieves an option
|
|
*
|
|
* @see Doctrine_Table::$options availible options
|
|
* @param mixed $name the name of the option
|
|
* @param mixed $value options value
|
|
* @return mixed
|
|
*/
|
|
public function option($name, $value = null)
|
|
{
|
|
if ($value === null) {
|
|
if (is_array($name)) {
|
|
foreach ($name as $k => $v) {
|
|
$this->_table->setOption($k, $v);
|
|
}
|
|
} else {
|
|
return $this->_table->getOption($name);
|
|
}
|
|
} else {
|
|
$this->_table->setOption($name, $value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* hasOne
|
|
* binds One-to-One aggregate relation
|
|
*
|
|
* @param string $componentName the name of the related component
|
|
* @param string $options relation options
|
|
* @see Doctrine_Relation::_$definition
|
|
* @return Doctrine_Record this object
|
|
*/
|
|
public function hasOne()
|
|
{
|
|
$this->_table->bind(func_get_args(), Doctrine_Relation::ONE);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* hasMany
|
|
* binds One-to-Many / Many-to-Many aggregate relation
|
|
*
|
|
* @param string $componentName the name of the related component
|
|
* @param string $options relation options
|
|
* @see Doctrine_Relation::_$definition
|
|
* @return Doctrine_Record this object
|
|
*/
|
|
public function hasMany()
|
|
{
|
|
$this->_table->bind(func_get_args(), Doctrine_Relation::MANY);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* hasColumn
|
|
* sets a column definition
|
|
*
|
|
* @param string $name
|
|
* @param string $type
|
|
* @param integer $length
|
|
* @param mixed $options
|
|
* @return void
|
|
*/
|
|
public function hasColumn($name, $type = null, $length = null, $options = array())
|
|
{
|
|
$this->_table->setColumn($name, $type, $length, $options);
|
|
}
|
|
public function hasColumns(array $definitions)
|
|
{
|
|
foreach ($definitions as $name => $options) {
|
|
$length = isset($options['length']) ? $options['length']:null;
|
|
$this->hasColumn($name, $options['type'], $length, $options);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* bindQueryParts
|
|
* binds query parts to given component
|
|
*
|
|
* @param array $queryParts an array of pre-bound query parts
|
|
* @return Doctrine_Record this object
|
|
*/
|
|
public function bindQueryParts(array $queryParts)
|
|
{
|
|
$this->_table->bindQueryParts($queryParts);
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function loadGenerator(Doctrine_Record_Generator $generator)
|
|
{
|
|
$generator->initialize($this->_table);
|
|
|
|
$this->_table->addGenerator($generator, get_class($generator));
|
|
}
|
|
|
|
|
|
/**
|
|
* Loads the given plugin.
|
|
*
|
|
* This method loads a behavior in the record. It will add the behavior
|
|
* also to the record table if it.
|
|
* It is tipically called in @see setUp().
|
|
*
|
|
* @param mixed $tpl if an object, must be a subclass of Doctrine_Template.
|
|
* If a string, Doctrine will try to instantiate an object of the classes Doctrine_Template_$tpl and subsequently $tpl, using also autoloading capabilities if defined.
|
|
* @param array $options argument to pass to the template constructor if $tpl is a class name
|
|
* @throws Doctrine_Record_Exception if $tpl is neither an instance of Doctrine_Template subclass or a valid class name, that could be instantiated.
|
|
* @return Doctrine_Record this object; provides a fluent interface.
|
|
*/
|
|
public function actAs($tpl, array $options = array())
|
|
{
|
|
if ( ! is_object($tpl)) {
|
|
$className = 'Doctrine_Template_' . $tpl;
|
|
|
|
if (class_exists($className, true)) {
|
|
$tpl = new $className($options);
|
|
} else if (class_exists($tpl, true)) {
|
|
$tpl = new $tpl($options);
|
|
} else {
|
|
throw new Doctrine_Record_Exception('Could not load behavior named: "' . $tpl . '"');
|
|
}
|
|
}
|
|
|
|
if ( ! ($tpl instanceof Doctrine_Template)) {
|
|
throw new Doctrine_Record_Exception('Loaded behavior class is not an instance of Doctrine_Template.');
|
|
}
|
|
|
|
$className = get_class($tpl);
|
|
|
|
$this->_table->addTemplate($className, $tpl);
|
|
|
|
$tpl->setInvoker($this);
|
|
$tpl->setTable($this->_table);
|
|
$tpl->setUp();
|
|
$tpl->setTableDefinition();
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds a check constraint.
|
|
*
|
|
* This method will add a CHECK constraint to the record table.
|
|
*
|
|
* @param mixed $constraint either a SQL constraint portion or an array of CHECK constraints. If array, all values will be added as constraint
|
|
* @param string $name optional constraint name. Not used if $constraint is an array.
|
|
* @return Doctrine_Record this object
|
|
*/
|
|
public function check($constraint, $name = null)
|
|
{
|
|
if (is_array($constraint)) {
|
|
foreach ($constraint as $name => $def) {
|
|
$this->_table->addCheckConstraint($def, $name);
|
|
}
|
|
} else {
|
|
$this->_table->addCheckConstraint($constraint, $name);
|
|
}
|
|
return $this;
|
|
}
|
|
}
|