1
0
mirror of synced 2024-12-15 15:46:02 +03:00
doctrine2/lib/Doctrine/Table.php

1772 lines
52 KiB
PHP
Raw Normal View History

<?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.com>.
*/
/**
* Doctrine_Table represents a database table
* each Doctrine_Table holds the information of foreignKeys and associations
*
*
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @subpackage Table
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Revision$
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Table extends Doctrine_Configurable implements Countable
{
/**
* @var array $data temporary data which is then loaded into Doctrine_Record::$_data
*/
2007-10-16 01:39:35 +04:00
protected $_data = array();
/**
* @var mixed $identifier
*/
2007-10-16 01:39:35 +04:00
protected $_identifier;
/**
* @see Doctrine_Identifier constants
* @var integer $identifierType the type of identifier this table uses
*/
2007-10-16 01:39:35 +04:00
protected $_identifierType;
/**
* @var Doctrine_Connection $conn Doctrine_Connection object that created this table
*/
2007-10-16 01:39:35 +04:00
protected $_conn;
/**
* @var array $identityMap first level cache
*/
2007-10-16 01:39:35 +04:00
protected $_identityMap = array();
/**
* @var Doctrine_Table_Repository $repository record repository
*/
2007-10-16 01:39:35 +04:00
protected $_repository;
/**
* @var array $columns an array of column definitions,
* keys as column names and values as column definitions
*
2007-07-10 03:01:59 +04:00
* the definition array has atleast the following values:
*
2007-07-10 03:01:59 +04:00
* -- type the column type, eg. 'integer'
* -- length the column length, eg. 11
*
2007-07-10 03:01:59 +04:00
* additional keys:
* -- notnull whether or not the column is marked as notnull
* -- values enum values
* -- notblank notblank validator + notnull constraint
* ... many more
*/
2007-09-21 00:58:54 +04:00
protected $_columns = array();
/**
* @var array $columnAliases an array of column aliases
* keys as column aliases and values as column names
*/
2007-09-21 00:58:54 +04:00
protected $_columnAliases = array();
/**
* @var integer $columnCount cached column count, Doctrine_Record uses this column count in when
* determining its state
*/
2007-10-16 01:39:35 +04:00
protected $columnCount;
/**
* @var boolean $hasDefaultValues whether or not this table has default values
*/
2007-10-16 01:39:35 +04:00
protected $hasDefaultValues;
/**
* @var array $options an array containing all options
*
* -- name name of the component, for example component name of the GroupTable is 'Group'
*
* -- parents the parent classes of this component
*
* -- declaringClass name of the table definition declaring class (when using inheritance the class
* that defines the table structure can be any class in the inheritance hierarchy,
* hence we need reflection to check out which class actually calls setTableDefinition)
*
* -- tableName database table name, in most cases this is the same as component name but in some cases
* where one-table-multi-class inheritance is used this will be the name of the inherited table
*
* -- sequenceName Some databases need sequences instead of auto incrementation primary keys,
* you can set specific sequence for your table by calling setOption('sequenceName', $seqName)
* where $seqName is the name of the desired sequence
*
* -- enumMap enum value arrays
*
* -- inheritanceMap inheritanceMap is used for inheritance mapping, keys representing columns and values
* the column values that should correspond to child classes
*
* -- type table type (mysql example: INNODB)
*
* -- charset character set
*
* -- foreignKeys the foreign keys of this table
*
2007-07-24 03:18:11 +04:00
* -- checks the check constraints of this table, eg. 'price > dicounted_price'
*
* -- collation collation attribute
*
* -- indexes the index definitions of this table
*
* -- treeImpl the tree implementation of this table (if any)
*
* -- treeOptions the tree options
2007-06-07 21:04:56 +04:00
*
* -- queryParts the bound query parts
*
2007-06-07 21:04:56 +04:00
* -- versioning
*/
protected $_options = array('name' => null,
'tableName' => null,
'sequenceName' => null,
'inheritanceMap' => array(),
'enumMap' => array(),
'type' => null,
'charset' => null,
'collation' => null,
'treeImpl' => null,
'treeOptions' => null,
'indexes' => array(),
'parents' => array(),
'queryParts' => array(),
'versioning' => null,
);
/**
* @var Doctrine_Tree $tree tree object associated with this table
*/
2007-09-21 00:53:15 +04:00
protected $_tree;
/**
* @var Doctrine_Relation_Parser $_parser relation parser object
*/
protected $_parser;
2007-06-08 23:27:38 +04:00
/**
2007-07-18 00:59:09 +04:00
* @var array $_templates an array containing all templates attached to this table
2007-06-08 23:27:38 +04:00
*/
2007-09-21 17:48:31 +04:00
protected $_templates = array();
2007-09-21 17:48:31 +04:00
/**
* @var array $_filters an array containing all record filters attached to this table
*/
protected $_filters = array();
2007-10-16 01:39:35 +04:00
/**
* @var array $_invokedMethods method invoker cache
*/
2007-10-08 03:36:28 +04:00
protected $_invokedMethods = array();
2007-09-21 17:48:31 +04:00
2007-07-18 00:59:09 +04:00
/**
* the constructor
2007-10-16 01:39:35 +04:00
*
* @throws Doctrine_Connection_Exception if there are no opened connections
2007-10-16 01:39:35 +04:00
* @param string $name the name of the component
* @param Doctrine_Connection $conn the connection associated with this table
*/
2007-10-16 02:01:04 +04:00
public function __construct($name, Doctrine_Connection $conn, $initDefinition = false)
{
2007-09-21 00:21:08 +04:00
$this->_conn = $conn;
2007-09-21 00:21:08 +04:00
$this->setParent($this->_conn);
$this->_options['name'] = $name;
$this->_parser = new Doctrine_Relation_Parser($this);
2007-10-16 02:01:04 +04:00
if ($initDefinition) {
$record = $this->initDefinition($name);
$this->initIdentifier();
$record->setUp();
// if tree, set up tree
if ($this->isTree()) {
$this->getTree()->setUp();
}
2007-10-16 01:39:35 +04:00
}
$this->_filters[] = new Doctrine_Record_Filter_Standard();
$this->_repository = new Doctrine_Table_Repository($this);
}
public function initDefinition($name)
{
if ( ! class_exists($name) || empty($name)) {
throw new Doctrine_Exception("Couldn't find class " . $name);
}
$record = new $name($this);
$names = array();
$class = $name;
// get parent classes
do {
2007-09-01 19:51:46 +04:00
if ($class === 'Doctrine_Record') {
break;
}
2007-10-13 01:32:26 +04:00
$name = $class;
$names[] = $name;
} while ($class = get_parent_class($class));
2007-10-13 01:32:26 +04:00
if ($class === false) {
throw new Doctrine_Table_Exception('Unknown component.');
}
// reverse names
$names = array_reverse($names);
// save parents
array_pop($names);
$this->_options['parents'] = $names;
// create database table
if (method_exists($record, 'setTableDefinition')) {
$record->setTableDefinition();
2007-08-14 01:39:29 +04:00
// get the declaring class of setTableDefinition method
$method = new ReflectionMethod($this->_options['name'], 'setTableDefinition');
2007-08-14 01:39:29 +04:00
$class = $method->getDeclaringClass();
} else {
$class = new ReflectionClass($class);
}
$this->_options['joinedParents'] = array();
foreach (array_reverse($this->_options['parents']) as $parent) {
if ($parent === $class->getName()) {
continue;
}
2007-11-10 16:21:40 +03:00
$ref = new ReflectionClass($parent);
if ($ref->isAbstract()) {
continue;
}
$table = $this->_conn->getTable($parent);
$found = false;
$columns = $table->getColumns();
foreach ($columns as $column => $definition) {
if ( ! isset($definition['primary'])) {
if (isset($this->_columns[$column])) {
$found = true;
break;
} else {
if ( ! isset($columns[$column]['owner'])) {
$columns[$column]['owner'] = $table->getComponentName();
}
$this->_options['joinedParents'][] = $columns[$column]['owner'];
}
} else {
unset($columns[$column]);
}
}
if ($found) {
continue;
}
$this->_columns = array_merge($columns, $this->_columns);
break;
}
$this->_options['joinedParents'] = array_values(array_unique($this->_options['joinedParents']));
$this->_options['declaringClass'] = $class;
2007-08-14 01:39:29 +04:00
// set the table definition for the given tree implementation
if ($this->isTree()) {
$this->getTree()->setTableDefinition();
}
2007-09-21 00:58:54 +04:00
$this->columnCount = count($this->_columns);
2007-10-16 01:39:35 +04:00
if ( ! isset($this->_options['tableName'])) {
$this->_options['tableName'] = Doctrine::tableize($class->getName());
2007-08-14 01:39:29 +04:00
}
2007-10-16 00:43:24 +04:00
2007-10-16 01:39:35 +04:00
return $record;
2007-10-16 00:43:24 +04:00
}
public function initIdentifier()
{
2007-09-21 00:58:54 +04:00
switch (count($this->_identifier)) {
2007-08-14 01:39:29 +04:00
case 0:
if ( ! empty($this->_options['joinedParents'])) {
$root = current($this->_options['joinedParents']);
$table = $this->_conn->getTable($root);
$this->_identifier = $table->getIdentifier();
$this->_identifierType = ($table->getIdentifierType() !== Doctrine::IDENTIFIER_AUTOINC)
? $table->getIdentifierType() : Doctrine::IDENTIFIER_NATURAL;
// add all inherited primary keys
foreach ((array) $this->_identifier as $id) {
$definition = $table->getDefinitionOf($id);
// inherited primary keys shouldn't contain autoinc
// and sequence definitions
unset($definition['autoincrement']);
unset($definition['sequence']);
// add the inherited primary key column
$this->_columns = array_merge(array($id => $definition), $this->_columns);
}
} else {
$this->_columns = array_merge(array('id' =>
array('type' => 'integer',
'length' => 20,
'autoincrement' => true,
'primary' => true)), $this->_columns);
$this->_identifier = 'id';
$this->_identifierType = Doctrine::IDENTIFIER_AUTOINC;
}
2007-08-14 01:39:29 +04:00
$this->columnCount++;
break;
2007-09-21 00:53:15 +04:00
case 1:
2007-09-21 00:58:54 +04:00
foreach ($this->_identifier as $pk) {
$e = $this->_columns[$pk];
2007-09-21 00:53:15 +04:00
$found = false;
2007-09-21 00:53:15 +04:00
foreach ($e as $option => $value) {
2007-10-16 00:43:24 +04:00
if ($found) {
break;
}
2007-09-21 00:53:15 +04:00
$e2 = explode(':', $option);
switch (strtolower($e2[0])) {
case 'autoincrement':
case 'autoinc':
$this->_identifierType = Doctrine::IDENTIFIER_AUTOINC;
$found = true;
break;
case 'seq':
case 'sequence':
$this->_identifierType = Doctrine::IDENTIFIER_SEQUENCE;
$found = true;
if ($value) {
$this->_options['sequenceName'] = $value;
2007-09-21 00:53:15 +04:00
} else {
if (($sequence = $this->getAttribute(Doctrine::ATTR_DEFAULT_SEQUENCE)) !== null) {
$this->_options['sequenceName'] = $sequence;
2007-08-14 01:39:29 +04:00
} else {
$this->_options['sequenceName'] = $this->_conn->getSequenceName($this->_options['tableName']);
2007-08-14 01:39:29 +04:00
}
2007-09-21 00:53:15 +04:00
}
break;
2007-08-14 01:39:29 +04:00
}
}
2007-09-21 00:53:15 +04:00
if ( ! isset($this->_identifierType)) {
$this->_identifierType = Doctrine::IDENTIFIER_NATURAL;
}
}
2007-09-21 00:58:54 +04:00
$this->_identifier = $pk;
2007-09-21 00:53:15 +04:00
break;
default:
$this->_identifierType = Doctrine::IDENTIFIER_COMPOSITE;
}
}
2007-10-16 00:43:24 +04:00
2007-11-10 16:21:40 +03:00
public function getColumnOwner($column)
{
if (isset($this->_columns[$column]['owner'])) {
return $this->_columns[$column]['owner'];
} else {
return $this->getComponentName();
}
}
public function isInheritedColumn($column)
{
return (isset($this->_columns[$column]['owner']));
}
2007-10-22 21:33:47 +04:00
public function isIdentifier($identifier)
{
return ($identifier === $this->_identifier ||
in_array($identifier, (array) $this->_identifier));
}
public function getMethodOwner($method)
2007-10-08 03:36:28 +04:00
{
return (isset($this->_invokedMethods[$method])) ?
$this->_invokedMethods[$method] : false;
}
public function setMethodOwner($method, $class)
{
$this->_invokedMethods[$method] = $class;
}
/**
* getTemplates
* returns all templates attached to this table
*
* @return array an array containing all templates
*/
public function getTemplates()
{
return $this->_templates;
}
/**
* export
* exports this table to database based on column and option definitions
*
* @throws Doctrine_Connection_Exception if some error other than Doctrine::ERR_ALREADY_EXISTS
* occurred during the create table operation
* @return boolean whether or not the export operation was successful
* false if table already existed in the database
*/
public function export()
{
2007-09-21 00:21:08 +04:00
$this->_conn->export->exportTable($this);
}
2007-06-06 01:00:39 +04:00
/**
* getExportableFormat
* returns exportable presentation of this object
*
* @return array
*/
2007-06-07 21:04:56 +04:00
public function getExportableFormat($parseForeignKeys = true)
2007-06-06 01:00:39 +04:00
{
$columns = array();
$primary = array();
foreach ($this->getColumns() as $name => $column) {
2007-06-28 15:56:56 +04:00
$definition = $column;
2007-06-06 01:00:39 +04:00
if (isset($column['owner'])) {
continue;
}
2007-06-06 01:00:39 +04:00
switch ($definition['type']) {
2007-06-28 15:56:56 +04:00
case 'enum':
if (isset($definition['default'])) {
$definition['default'] = $this->enumIndex($name, $definition['default']);
}
break;
case 'boolean':
if (isset($definition['default'])) {
$definition['default'] = $this->getConnection()->convertBooleans($definition['default']);
}
break;
2007-06-06 01:00:39 +04:00
}
$columns[$name] = $definition;
if (isset($definition['primary']) && $definition['primary']) {
2007-06-06 01:00:39 +04:00
$primary[] = $name;
}
}
2007-06-15 00:43:04 +04:00
$options['foreignKeys'] = array();
2007-06-06 01:00:39 +04:00
2007-06-07 21:04:56 +04:00
if ($parseForeignKeys) {
if ($this->getAttribute(Doctrine::ATTR_EXPORT) & Doctrine::EXPORT_CONSTRAINTS) {
2007-06-15 00:43:04 +04:00
$constraints = array();
$emptyIntegrity = array('onUpdate' => null,
'onDelete' => null);
2007-06-07 21:04:56 +04:00
foreach ($this->getRelations() as $name => $relation) {
$fk = $relation->toArray();
$fk['foreignTable'] = $relation->getTable()->getTableName();
2007-06-15 00:43:04 +04:00
2007-06-07 21:04:56 +04:00
if ($relation->getTable() === $this && in_array($relation->getLocal(), $primary)) {
2007-06-15 00:43:04 +04:00
if ($relation->hasConstraint()) {
throw new Doctrine_Table_Exception("Badly constructed integrity constraints.");
}
2007-06-15 00:43:04 +04:00
continue;
2007-06-07 21:04:56 +04:00
}
2007-06-15 00:43:04 +04:00
$integrity = array('onUpdate' => $fk['onUpdate'],
'onDelete' => $fk['onDelete']);
2007-06-27 02:35:08 +04:00
if ($relation instanceof Doctrine_Relation_LocalKey) {
2007-06-15 00:43:04 +04:00
$def = array('local' => $relation->getLocal(),
2007-07-13 20:22:49 +04:00
'foreign' => $relation->getForeign(),
2007-06-15 00:43:04 +04:00
'foreignTable' => $relation->getTable()->getTableName());
if (($key = array_search($def, $options['foreignKeys'])) === false) {
$options['foreignKeys'][] = $def;
$constraints[] = $integrity;
} else {
if ($integrity !== $emptyIntegrity) {
$constraints[$key] = $integrity;
}
}
2007-06-07 21:04:56 +04:00
}
2007-06-15 00:43:04 +04:00
}
foreach ($constraints as $k => $def) {
$options['foreignKeys'][$k] = array_merge($options['foreignKeys'][$k], $def);
2007-06-06 01:00:39 +04:00
}
2007-06-15 00:43:04 +04:00
2007-06-06 01:00:39 +04:00
}
}
2007-06-15 00:43:04 +04:00
$options['primary'] = $primary;
return array('tableName' => $this->getOption('tableName'),
'columns' => $columns,
2007-06-06 01:02:21 +04:00
'options' => array_merge($this->getOptions(), $options));
2007-06-06 01:00:39 +04:00
}
/**
* exportConstraints
* exports the constraints of this table into database based on option definitions
*
* @throws Doctrine_Connection_Exception if something went wrong on db level
* @return void
*/
public function exportConstraints()
{
try {
2007-09-21 00:21:08 +04:00
$this->_conn->beginTransaction();
foreach ($this->_options['index'] as $index => $definition) {
$this->_conn->export->createIndex($this->_options['tableName'], $index, $definition);
}
2007-09-21 00:21:08 +04:00
$this->_conn->commit();
} catch(Doctrine_Connection_Exception $e) {
2007-09-21 00:21:08 +04:00
$this->_conn->rollback();
throw $e;
}
}
/**
* getRelationParser
* return the relation parser associated with this table
*
* @return Doctrine_Relation_Parser relation parser object
*/
public function getRelationParser()
{
return $this->_parser;
}
/**
* __get
* an alias for getOption
*
* @param string $option
*/
public function __get($option)
{
if (isset($this->_options[$option])) {
return $this->_options[$option];
}
return null;
}
/**
* __isset
*
* @param string $option
*/
public function __isset($option)
{
return isset($this->_options[$option]);
}
2007-06-06 00:55:54 +04:00
/**
* getOptions
* returns all options of this table and the associated values
*
* @return array all options and their values
*/
public function getOptions()
{
return $this->_options;
2007-06-06 00:55:54 +04:00
}
/**
* addForeignKey
*
* adds a foreignKey to this table
*
* @return void
*/
public function addForeignKey(array $definition)
{
$this->_options['foreignKeys'][] = $definition;
}
2007-07-24 03:18:11 +04:00
/**
* addCheckConstraint
*
2007-07-24 03:18:11 +04:00
* adds a check constraint to this table
*
* @return void
*/
public function addCheckConstraint($definition, $name)
{
if (is_string($name)) {
$this->_options['checks'][$name] = $definition;
2007-07-24 03:18:11 +04:00
} else {
$this->_options['checks'][] = $definition;
2007-07-24 03:18:11 +04:00
}
2007-07-24 03:18:11 +04:00
return $this;
}
/**
* addIndex
*
* adds an index to this table
*
* @return void
*/
public function addIndex($index, array $definition)
{
$this->_options['indexes'][$index] = $definition;
}
/**
* getIndex
*
* @return array|boolean array on success, FALSE on failure
*/
public function getIndex($index)
{
if (isset($this->_options['indexes'][$index])) {
return $this->_options['indexes'][$index];
}
return false;
}
public function bind($args, $type)
{
$options = array();
$options['type'] = $type;
2007-06-27 20:59:23 +04:00
if ( ! isset($args[1])) {
$args[1] = array();
}
// the following is needed for backwards compatibility
if (is_string($args[1])) {
if ( ! isset($args[2])) {
$args[2] = array();
} elseif (is_string($args[2])) {
$args[2] = (array) $args[2];
}
$classes = array_merge($this->_options['parents'], array($this->getComponentName()));
$e = explode('.', $args[1]);
if (in_array($e[0], $classes)) {
if ($options['type'] >= Doctrine_Relation::MANY) {
$options['foreign'] = $e[1];
} else {
$options['local'] = $e[1];
}
} else {
$e2 = explode(' as ', $args[0]);
if ($e[0] !== $e2[0] && ( ! isset($e2[1]) || $e[0] !== $e2[1])) {
$options['refClass'] = $e[0];
}
$options['foreign'] = $e[1];
}
$options = array_merge($args[2], $options);
$this->_parser->bind($args[0], $options);
} else {
$options = array_merge($args[1], $options);
$this->_parser->bind($args[0], $options);
}
}
2007-07-21 19:46:31 +04:00
/**
2007-07-21 19:46:31 +04:00
* hasRelation
*
* @param string $alias the relation to check if exists
* @return boolean true if the relation exists otherwise false
*/
public function hasRelation($alias)
{
return $this->_parser->hasRelation($alias);
}
2007-07-21 19:46:31 +04:00
/**
* getRelation
*
* @param string $alias relation alias
*/
public function getRelation($alias, $recursive = true)
{
return $this->_parser->getRelation($alias, $recursive);
}
/**
* getRelations
* returns an array containing all relation objects
*
* @return array an array of Doctrine_Relation objects
*/
public function getRelations()
{
return $this->_parser->getRelations();
}
/**
* createQuery
* creates a new Doctrine_Query object and adds the component name
* of this table as the query 'from' part
*
* @param string Optional alias name for component aliasing.
*
* @return Doctrine_Query
*/
public function createQuery($alias = '')
{
if ( ! empty($alias)) {
$alias = ' ' . trim($alias);
}
return Doctrine_Query::create($this->_conn)->from($this->getComponentName() . $alias);
}
/**
* getRepository
*
* @return Doctrine_Table_Repository
*/
public function getRepository()
{
2007-09-21 00:48:53 +04:00
return $this->_repository;
}
/**
* setOption
* sets an option and returns this object in order to
* allow flexible method chaining
*
* @see Doctrine_Table::$_options for available options
* @param string $name the name of the option to set
* @param mixed $value the value of the option
* @return Doctrine_Table this object
*/
public function setOption($name, $value)
{
switch ($name) {
case 'name':
case 'tableName':
break;
case 'enumMap':
case 'inheritanceMap':
case 'index':
case 'treeOptions':
if ( ! is_array($value)) {
throw new Doctrine_Table_Exception($name . ' should be an array.');
}
break;
}
$this->_options[$name] = $value;
}
/**
* getOption
* returns the value of given option
*
* @param string $name the name of the option
* @return mixed the value of given option
*/
public function getOption($name)
{
if (isset($this->_options[$name])) {
return $this->_options[$name];
}
return null;
}
/**
* getColumnName
*
* returns a column name for column alias
* if the actual name for the alias cannot be found
* this method returns the given alias
*
* @param string $alias column alias
* @return string column name
*/
public function getColumnName($alias)
{
$alias = strtolower($alias);
2007-09-21 00:58:54 +04:00
if (isset($this->_columnAliases[$alias])) {
return $this->_columnAliases[$alias];
}
return $alias;
}
/**
* setColumn
*
* @param string $name
* @param string $type
* @param integer $length
* @param mixed $options
* @throws Doctrine_Table_Exception if trying use wrongly typed parameter
* @return void
*/
public function setColumn($name, $type, $length = null, $options = array())
{
if (is_string($options)) {
$options = explode('|', $options);
}
foreach ($options as $k => $option) {
if (is_numeric($k)) {
if ( ! empty($option)) {
$options[$option] = true;
}
unset($options[$k]);
}
}
$name = strtolower($name);
$parts = explode(' as ', $name);
if (count($parts) > 1) {
2007-09-21 00:58:54 +04:00
$this->_columnAliases[$parts[1]] = $parts[0];
$name = $parts[0];
}
if ($length == null) {
switch ($type) {
case 'string':
case 'clob':
case 'float':
case 'integer':
case 'array':
case 'object':
case 'blob':
case 'gzip':
// use php int max
$length = 2147483647;
break;
case 'boolean':
$length = 1;
case 'date':
// YYYY-MM-DD ISO 8601
$length = 10;
case 'time':
// HH:NN:SS+00:00 ISO 8601
$length = 14;
case 'timestamp':
// YYYY-MM-DDTHH:MM:SS+00:00 ISO 8601
$length = 25;
break;
}
}
2007-09-21 00:58:54 +04:00
$this->_columns[$name] = $options;
$this->_columns[$name]['type'] = $type;
$this->_columns[$name]['length'] = $length;
if (isset($options['primary'])) {
2007-09-21 00:58:54 +04:00
$this->_identifier[] = $name;
}
if (isset($options['default'])) {
$this->hasDefaultValues = true;
}
}
/**
* hasDefaultValues
* returns true if this table has default values, otherwise false
*
* @return boolean
*/
public function hasDefaultValues()
{
return $this->hasDefaultValues;
}
/**
* getDefaultValueOf
* returns the default value(if any) for given column
*
* @param string $column
* @return mixed
*/
public function getDefaultValueOf($column)
{
$column = strtolower($column);
2007-09-21 00:58:54 +04:00
if ( ! isset($this->_columns[$column])) {
throw new Doctrine_Table_Exception("Couldn't get default value. Column ".$column." doesn't exist.");
}
2007-09-21 00:58:54 +04:00
if (isset($this->_columns[$column]['default'])) {
return $this->_columns[$column]['default'];
} else {
return null;
}
}
/**
* @return mixed
*/
public function getIdentifier()
{
2007-09-21 00:48:53 +04:00
return $this->_identifier;
}
/**
* @return integer
*/
public function getIdentifierType()
{
2007-09-21 00:48:53 +04:00
return $this->_identifierType;
}
/**
* hasColumn
* @return boolean
*/
public function hasColumn($name)
{
2007-09-21 00:58:54 +04:00
return isset($this->_columns[$name]);
}
2007-10-16 01:39:35 +04:00
/**
* sets the connection for this class
*
* @params Doctrine_Connection a connection object
* @return Doctrine_Table this object
*/
public function setConnection(Doctrine_Connection $conn)
{
$this->_conn = $conn;
$this->setParent($this->_conn);
return $this;
}
/**
2007-10-16 01:39:35 +04:00
* returns the connection associated with this table (if any)
*
* @return Doctrine_Connection|null the connection object
*/
public function getConnection()
{
2007-09-21 00:21:08 +04:00
return $this->_conn;
}
/**
* creates a new record
*
2007-10-16 01:39:35 +04:00
* @param $array an array where keys are field names and
* values representing field values
* @return Doctrine_Record the created record object
*/
2007-10-16 01:39:35 +04:00
public function create(array $array = array())
{
$record = new $this->_options['name']($this, true);
$record->fromArray($array);
2007-10-16 01:39:35 +04:00
return $record;
}
/**
* finds a record by its identifier
*
* @param $id database row id
2007-09-06 18:12:40 +04:00
* @param int $hydrationMode Doctrine::HYDRATE_ARRAY or Doctrine::HYDRATE_RECORD
* @return mixed Array or Doctrine_Record or false if no result
*/
public function find($id, $hydrationMode = null)
{
2007-09-06 18:12:40 +04:00
if (is_null($id)) {
return false;
}
2007-09-06 18:12:40 +04:00
$id = is_array($id) ? array_values($id) : array($id);
2007-09-06 18:12:40 +04:00
return $this->createQuery()
2007-09-21 00:58:54 +04:00
->where(implode(' = ? AND ', (array) $this->_identifier) . ' = ?')
2007-09-06 18:12:40 +04:00
->fetchOne($id, $hydrationMode);
}
/**
* findAll
* returns a collection of records
*
* @param int $hydrationMode Doctrine::FETCH_ARRAY or Doctrine::FETCH_RECORD
* @return Doctrine_Collection
*/
public function findAll($hydrationMode = null)
{
return $this->createQuery()->execute(array(), $hydrationMode);
}
/**
* findByDql
* finds records with given DQL where clause
* returns a collection of records
*
* @param string $dql DQL after WHERE clause
* @param array $params query parameters
* @param int $hydrationMode Doctrine::FETCH_ARRAY or Doctrine::FETCH_RECORD
* @return Doctrine_Collection
*/
public function findBySql($dql, array $params = array(), $hydrationMode = null)
{
return $this->createQuery()->where($dql)->execute($params, $hydrationMode);
}
public function findByDql($dql, array $params = array(), $hydrationMode = null)
{
return $this->findBySql($dql, $params, $hydrationMode);
}
/**
* execute
* fetches data using the provided queryKey and
* the associated query in the query registry
*
* if no query for given queryKey is being found a
* Doctrine_Query_Registry exception is being thrown
*
* @param string $queryKey the query key
* @param array $params prepared statement params (if any)
* @return mixed the fetched data
*/
public function execute($queryKey, $params = array(), $hydrationMode = Doctrine::HYDRATE_RECORD)
{
return Doctrine_Manager::getInstance()
->getQueryRegistry()
->get($queryKey, $this->getComponentName())
->execute($params, $hydrationMode);
}
/**
* executeOne
* fetches data using the provided queryKey and
* the associated query in the query registry
*
* if no query for given queryKey is being found a
* Doctrine_Query_Registry exception is being thrown
*
* @param string $queryKey the query key
* @param array $params prepared statement params (if any)
* @return mixed the fetched data
*/
public function executeOne($queryKey, $params = array(), $hydrationMode = Doctrine::HYDRATE_RECORD)
{
return Doctrine_Manager::getInstance()
->getQueryRegistry()
->get($queryKey, $this->getComponentName())
->fetchOne($params, $hydrationMode);
}
/**
* clear
* clears the first level cache (identityMap)
*
* @return void
*/
public function clear()
{
2007-09-21 00:48:53 +04:00
$this->_identityMap = array();
}
/**
* addRecord
* adds a record to identity map
*
* @param Doctrine_Record $record record to be added
* @return boolean
*/
public function addRecord(Doctrine_Record $record)
{
$id = implode(' ', $record->identifier());
2007-09-21 00:48:53 +04:00
if (isset($this->_identityMap[$id])) {
return false;
}
2007-09-21 00:48:53 +04:00
$this->_identityMap[$id] = $record;
return true;
}
/**
* removeRecord
* removes a record from the identity map, returning true if the record
* was found and removed and false if the record wasn't found.
*
* @param Doctrine_Record $record record to be removed
* @return boolean
*/
public function removeRecord(Doctrine_Record $record)
{
$id = implode(' ', $record->identifier());
if (isset($this->_identityMap[$id])) {
unset($this->_identityMap[$id]);
return true;
}
return false;
}
/**
* getRecord
* first checks if record exists in identityMap, if not
* returns a new record
*
* @return Doctrine_Record
*/
public function getRecord()
{
2007-09-21 00:53:15 +04:00
if ( ! empty($this->_data)) {
$this->_data = array_change_key_case($this->_data, CASE_LOWER);
$key = $this->getIdentifier();
if ( ! is_array($key)) {
$key = array($key);
}
2007-05-31 21:45:07 +04:00
$found = false;
foreach ($key as $k) {
2007-09-21 00:53:15 +04:00
if ( ! isset($this->_data[$k])) {
2007-05-31 21:45:07 +04:00
// primary key column not found return new record
$found = true;
break;
}
2007-09-21 00:53:15 +04:00
$id[] = $this->_data[$k];
}
2007-05-31 21:45:07 +04:00
if ($found) {
$recordName = $this->getClassnameToReturn();
2007-07-16 23:19:29 +04:00
$record = new $recordName($this, true);
2007-09-21 00:53:15 +04:00
$this->_data = array();
2007-05-31 21:45:07 +04:00
return $record;
}
$id = implode(' ', $id);
2007-09-21 00:48:53 +04:00
if (isset($this->_identityMap[$id])) {
$record = $this->_identityMap[$id];
2007-09-21 00:53:15 +04:00
$record->hydrate($this->_data);
} else {
$recordName = $this->getClassnameToReturn();
$record = new $recordName($this);
2007-09-21 00:48:53 +04:00
$this->_identityMap[$id] = $record;
}
2007-09-21 00:53:15 +04:00
$this->_data = array();
} else {
$recordName = $this->getClassnameToReturn();
$record = new $recordName($this, true);
}
return $record;
}
/**
* Get the classname to return. Most often this is just the options['name']
*
* Check the subclasses option and the inheritanceMap for each subclass to see
* if all the maps in a subclass is met. If this is the case return that
* subclass name. If no subclasses match or if there are no subclasses defined
* return the name of the class for this tables record.
*
* @todo this function could use reflection to check the first time it runs
* if the subclassing option is not set.
*
* @return string The name of the class to create
*
*/
public function getClassnameToReturn()
{
if ( ! isset($this->_options['subclasses'])) {
return $this->_options['name'];
}
foreach ($this->_options['subclasses'] as $subclass) {
2007-09-21 00:21:08 +04:00
$table = $this->_conn->getTable($subclass);
$inheritanceMap = $table->getOption('inheritanceMap');
$nomatch = false;
foreach ($inheritanceMap as $key => $value) {
2007-09-21 00:53:15 +04:00
if ( ! isset($this->_data[$key]) || $this->_data[$key] != $value) {
$nomatch = true;
break;
}
}
if ( ! $nomatch) {
return $table->getComponentName();
}
}
return $this->_options['name'];
}
/**
* @param $id database row id
* @throws Doctrine_Find_Exception
*/
final public function getProxy($id = null)
{
if ($id !== null) {
2007-09-21 00:58:54 +04:00
$query = 'SELECT ' . implode(', ', (array) $this->_identifier)
. ' FROM ' . $this->getTableName()
2007-09-21 00:58:54 +04:00
. ' WHERE ' . implode(' = ? && ', (array) $this->_identifier) . ' = ?';
$query = $this->applyInheritance($query);
$params = array_merge(array($id), array_values($this->_options['inheritanceMap']));
2007-09-21 00:53:15 +04:00
$this->_data = $this->_conn->execute($query, $params)->fetch(PDO::FETCH_ASSOC);
2007-09-21 00:53:15 +04:00
if ($this->_data === false)
return false;
}
return $this->getRecord();
}
/**
* applyInheritance
* @param $where query where part to be modified
* @return string query where part with column aggregation inheritance added
*/
final public function applyInheritance($where)
{
if ( ! empty($this->_options['inheritanceMap'])) {
$a = array();
foreach ($this->_options['inheritanceMap'] as $field => $value) {
$a[] = $field . ' = ?';
}
$i = implode(' AND ', $a);
$where .= ' AND ' . $i;
}
return $where;
}
/**
* count
*
* @return integer
*/
public function count()
{
$a = $this->_conn->execute('SELECT COUNT(1) FROM ' . $this->_options['tableName'])->fetch(Doctrine::FETCH_NUM);
return current($a);
}
/**
* @return Doctrine_Query a Doctrine_Query object
*/
public function getQueryObject()
{
$graph = new Doctrine_Query($this->getConnection());
$graph->load($this->getComponentName());
return $graph;
}
/**
* @param string $field
* @return array
*/
2007-06-28 15:56:56 +04:00
public function getEnumValues($field)
{
2007-09-21 00:58:54 +04:00
if (isset($this->_columns[$field]['values'])) {
return $this->_columns[$field]['values'];
} else {
return array();
}
}
/**
* enumValue
*
* @param string $field
* @param integer $index
* @return mixed
*/
public function enumValue($field, $index)
{
if ($index instanceof Doctrine_Null) {
return $index;
}
if ( ! $this->_conn->getAttribute(Doctrine::ATTR_USE_NATIVE_ENUM)
2007-09-21 00:58:54 +04:00
&& isset($this->_columns[$field]['values'][$index])
) {
2007-09-21 00:58:54 +04:00
return $this->_columns[$field]['values'][$index];
}
return $index;
}
/**
* enumIndex
*
* @param string $field
* @param mixed $value
* @return mixed
*/
public function enumIndex($field, $value)
{
$values = $this->getEnumValues($field);
$index = array_search($value, $values);
2007-09-21 00:21:08 +04:00
if ($index === false || !$this->_conn->getAttribute(Doctrine::ATTR_USE_NATIVE_ENUM)) {
return $index;
}
return $value;
}
/* getColumnCount
*
* @return integer the number of columns in this table
*/
2007-06-28 15:56:56 +04:00
public function getColumnCount()
{
return $this->columnCount;
}
/**
* returns all columns and their definitions
*
* @return array
*/
2007-06-28 15:56:56 +04:00
public function getColumns()
{
2007-09-21 00:58:54 +04:00
return $this->_columns;
}
/**
* removeColumn
* removes given column
*
* @return boolean
*/
public function removeColumn($column)
{
if (isset($this->_columns[$column])) {
unset($this->_columns[$column]);
return true;
}
return false;
}
/**
* returns an array containing all the column names
*
* @return array
*/
public function getColumnNames()
{
2007-09-21 00:58:54 +04:00
return array_keys($this->_columns);
}
/**
* getDefinitionOf
*
* @return mixed array on success, false on failure
*/
public function getDefinitionOf($column)
{
2007-09-21 00:58:54 +04:00
if (isset($this->_columns[$column])) {
return $this->_columns[$column];
}
return false;
}
/**
* getTypeOf
*
* @return mixed string on success, false on failure
*/
public function getTypeOf($column)
{
2007-09-21 00:58:54 +04:00
if (isset($this->_columns[$column])) {
return $this->_columns[$column]['type'];
}
return false;
}
/**
* setData
* doctrine uses this function internally
* users are strongly discouraged to use this function
*
* @param array $data internal data
* @return void
*/
public function setData(array $data)
{
2007-09-21 00:53:15 +04:00
$this->_data = $data;
}
/**
* returns internal data, used by Doctrine_Record instances
* when retrieving data from database
*
* @return array
*/
2007-06-28 15:56:56 +04:00
public function getData()
{
2007-09-21 00:53:15 +04:00
return $this->_data;
}
2007-07-05 23:04:37 +04:00
/**
* prepareValue
* this method performs special data preparation depending on
2007-07-05 23:04:37 +04:00
* the type of the given column
*
* 1. It unserializes array and object typed columns
* 2. Uncompresses gzip typed columns
* 3. Gets the appropriate enum values for enum typed columns
* 4. Initializes special null object pointer for null values (for fast column existence checking purposes)
*
* example:
* <code type='php'>
* $field = 'name';
* $value = null;
* $table->prepareValue($field, $value); // Doctrine_Null
* </code>
*
* @throws Doctrine_Table_Exception if unserialization of array/object typed column fails or
* @throws Doctrine_Table_Exception if uncompression of gzip typed column fails *
* @param string $field the name of the field
* @param string $value field value
* @return mixed prepared value
*/
public function prepareValue($field, $value)
{
if ($value === self::$_null) {
2007-07-05 23:04:37 +04:00
return self::$_null;
2007-10-22 21:33:47 +04:00
} elseif ($value === null) {
return null;
2007-07-05 23:04:37 +04:00
} else {
$type = $this->getTypeOf($field);
switch ($type) {
case 'array':
case 'object':
if (is_string($value)) {
$value = unserialize($value);
if ($value === false) {
throw new Doctrine_Table_Exception('Unserialization of ' . $field . ' failed.');
}
return $value;
}
break;
case 'gzip':
$value = gzuncompress($value);
if ($value === false) {
throw new Doctrine_Table_Exception('Uncompressing of ' . $field . ' failed.');
}
return $value;
break;
case 'enum':
return $this->enumValue($field, $value);
break;
case 'boolean':
return (boolean) $value;
break;
case 'integer':
2007-07-20 13:38:10 +04:00
// don't do any casting here PHP INT_MAX is smaller than what the databases support
break;
2007-07-05 23:04:37 +04:00
}
}
return $value;
}
/**
* getTree
*
* getter for associated tree
*
* @return mixed if tree return instance of Doctrine_Tree, otherwise returns false
*/
public function getTree()
{
if (isset($this->_options['treeImpl'])) {
2007-09-21 00:53:15 +04:00
if ( ! $this->_tree) {
$options = isset($this->_options['treeOptions']) ? $this->_options['treeOptions'] : array();
2007-09-21 00:53:15 +04:00
$this->_tree = Doctrine_Tree::factory($this,
$this->_options['treeImpl'],
$options
);
}
2007-09-21 00:53:15 +04:00
return $this->_tree;
}
return false;
}
/**
* getComponentName
*
* @return void
*/
public function getComponentName()
{
return $this->_options['name'];
}
/**
* getTableName
*
* @return void
*/
public function getTableName()
{
return $this->_options['tableName'];
}
/**
* setTableName
*
* @param string $tableName
* @return void
*/
public function setTableName($tableName)
{
$this->setOption('tableName', $this->_conn->formatter->getTableName($tableName));
}
/**
* isTree
*
* determine if table acts as tree
*
* @return mixed if tree return true, otherwise returns false
*/
public function isTree()
{
return ( ! is_null($this->_options['treeImpl'])) ? true : false;
}
2007-07-18 00:59:09 +04:00
/**
* getTemplate
*
* @param string $template
* @return void
*/
2007-07-18 00:59:09 +04:00
public function getTemplate($template)
2007-06-08 23:27:38 +04:00
{
if ( ! isset($this->_templates[$template])) {
2007-07-18 00:59:09 +04:00
throw new Doctrine_Table_Exception('Template ' . $template . ' not loaded');
}
return $this->_templates[$template];
2007-07-18 00:59:09 +04:00
}
2007-10-09 01:22:13 +04:00
public function hasTemplate($template)
{
return isset($this->_templates[$template]);
}
2007-07-18 00:59:09 +04:00
public function addTemplate($template, Doctrine_Template $impl)
{
$this->_templates[$template] = $impl;
2007-09-21 17:48:31 +04:00
return $this;
}
2007-10-06 00:29:33 +04:00
/**
* 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->_options['queryParts'] = $queryParts;
2007-10-06 00:29:33 +04:00
return $this;
}
/**
* bindQueryPart
* binds given value to given query part
*
* @param string $queryPart
* @param mixed $value
* @return Doctrine_Record this object
*/
public function bindQueryPart($queryPart, $value)
{
$this->_options['queryParts'][$queryPart] = $value;
return $this;
}
/**
* getBoundQueryPart
*
* @param string $queryPart
* @return string $queryPart
*/
public function getBoundQueryPart($queryPart)
{
if ( ! isset($this->_options['queryParts'][$queryPart])) {
return null;
}
return $this->_options['queryParts'][$queryPart];
}
/**
* unshiftFilter
*
* @param object Doctrine_Record_Filter $filter
* @return object $this
*/
2007-09-21 17:48:31 +04:00
public function unshiftFilter(Doctrine_Record_Filter $filter)
{
$filter->setTable($this);
$filter->init();
2007-09-21 17:48:31 +04:00
array_unshift($this->_filters, $filter);
return $this;
}
/**
* getFilters
*
* @return array $filters
*/
2007-09-21 17:48:31 +04:00
public function getFilters()
{
return $this->_filters;
2007-06-08 23:27:38 +04:00
}
/**
* returns a string representation of this object
*
* @return string
*/
public function __toString()
{
return Doctrine_Lib::getTableAsString($this);
}
/**
* findBy
*
* @param string $column
* @param string $value
* @param string $hydrationMode
* @return void
*/
protected function findBy($column, $value, $hydrationMode = null)
{
return $this->createQuery()->where($column . ' = ?')->execute(array($value), $hydrationMode);
}
/**
* findOneBy
*
* @param string $column
* @param string $value
* @param string $hydrationMode
* @return void
*/
protected function findOneBy($column, $value, $hydrationMode = null)
{
$results = $this->createQuery()->where($column . ' = ?')->limit(1)->execute(array($value), $hydrationMode);
return $hydrationMode === Doctrine::FETCH_ARRAY ? $results[0]:$results->getFirst();
}
/**
* __call
*
* Adds support for magic finders.
* findByColumnName, findByRelationAlias
* findById, findByContactId, etc.
*
* @return void
*/
public function __call($method, $arguments)
{
if (substr($method, 0, 6) == 'findBy') {
$by = substr($method, 6, strlen($method));
$method = 'findBy';
} else if (substr($method, 0, 9) == 'findOneBy') {
$by = substr($method, 9, strlen($method));
$method = 'findOneBy';
}
if (isset($by)) {
if (!isset($arguments[0])) {
throw new Doctrine_Table_Exception('You must specify the value to findBy');
}
$column = Doctrine::tableize($by);
$hydrationMode = isset($arguments[1]) ? $arguments[1]:null;
if ($this->hasColumn($column)) {
return $this->$method($column, $arguments[0], $hydrationMode);
} else if ($this->hasRelation($by)) {
$relation = $this->getRelation($by);
if ($relation['type'] === Doctrine_Relation::MANY) {
throw new Doctrine_Table_Exception('Cannot findBy many relationship.');
}
return $this->$method($relation['local'], $arguments[0], $hydrationMode);
} else {
throw new Doctrine_Table_Exception('Cannot find by: ' . $by . '. Invalid column or relationship alias.');
}
}
}
2007-10-22 21:33:47 +04:00
}