Changeset 4699

Timestamp:

07/20/08 21:13:24 (6 months ago)

Author:

romanb

Message:

Checkin of occasional work from the past weeks.

Location:

trunk

Files:

• lib/Doctrine/Association (added)
• lib/Doctrine/Association.php (added)
• lib/Doctrine/Association/ManyToMany.php (added)
• lib/Doctrine/Association/OneToMany.php (added)
• lib/Doctrine/Association/OneToOne.php (added)
• lib/Doctrine/ClassMetadata.php (modified) (46 diffs)
• lib/Doctrine/ClassMetadata/Factory.php (modified) (13 diffs)
• lib/Doctrine/Collection.php (modified) (40 diffs)
• lib/Doctrine/Connection.php (modified) (12 diffs)
• lib/Doctrine/Connection/UnitOfWork.php (modified) (15 diffs)
• lib/Doctrine/Entity.php (modified) (18 diffs)
• lib/Doctrine/EntityManager.php (modified) (9 diffs)
• lib/Doctrine/EventListener.php (deleted)
• lib/Doctrine/EventSubscriber.php (added)
• lib/Doctrine/Exception.php (modified) (1 diff)
• lib/Doctrine/Hydrator/RecordDriver.php (modified) (1 diff)
• lib/Doctrine/HydratorNew.php (modified) (3 diffs)
• lib/Doctrine/Internal (added)
• lib/Doctrine/Internal/CommitOrderCalculator.php (added)
• lib/Doctrine/Internal/CommitOrderNode.php (added)
• lib/Doctrine/MappingException.php (modified) (1 diff)
• lib/Doctrine/Overloadable.php (modified) (1 diff)
• lib/Doctrine/Tree.php (modified) (1 diff)
• lib/Doctrine/Validator.php (modified) (1 diff)
• tests/lib/mocks/Doctrine_ConnectionMock.php (added)
• tests/lib/mocks/Doctrine_EntityManagerMock.php (added)
• tests/lib/mocks/Doctrine_EntityPersisterMock.php (added)
• tests/lib/mocks/Doctrine_SequenceMock.php (added)
• tests/models/cms/CmsArticle.php (modified) (1 diff)
• tests/models/cms/CmsComment.php (modified) (1 diff)
• tests/models/cms/CmsPhonenumber.php (modified) (1 diff)
• tests/models/cms/CmsUser.php (modified) (1 diff)
• tests/models/forum/ForumAdministrator.php (modified) (1 diff)
• tests/models/forum/ForumBoard.php (modified) (2 diffs)
• tests/models/forum/ForumCategory.php (modified) (1 diff)
• tests/models/forum/ForumEntry.php (added)
• tests/models/forum/ForumUser.php (modified) (2 diffs)
• tests/Orm/Associations (added)
• tests/Orm/Associations/CascadeTest.php (added)
• tests/Orm/Associations/OneToOneMappingTest.php (added)
• tests/Orm/Component/CollectionTest.php (modified) (3 diffs)
• tests/Orm/Entity/AccessorTest.php (modified) (2 diffs)
• tests/Orm/Entity/ConstructorTest.php (modified) (1 diff)
• tests/Orm/UnitOfWorkTest.php (modified) (4 diffs)

trunk/lib/Doctrine/ClassMetadata.php

@@ -22 +22 @@
 #namespace Doctrine::ORM::Mapping;
 
+#use Doctrine::ORM::EntityManager;
+
 /**
  * A <tt>ClassMetadata</tt> instance holds all the information (metadata) of an entity and
@@ -29 +31 @@
  * @author Roman Borschel <roman@code-factory.org>
  * @since 2.0
+ * @todo Rename to ClassDescriptor?
  */
 class Doctrine_ClassMetadata implements Doctrine_Configurable, Serializable
 {
-    /**
-     * The name of the entity class that is mapped to the database with this metadata.
+    /* The inheritance mapping types */
+    const INHERITANCE_TYPE_NONE = 'none';
+    const INHERITANCE_TYPE_JOINED = 'joined';
+    const INHERITANCE_TYPE_SINGLE_TABLE = 'singleTable';
+    const INHERITANCE_TYPE_TABLE_PER_CLASS = 'tablePerClass';
+    
+    /**
+     * Inheritance types enumeration.
+     *
+     * @var array
+     */
+    protected static $_inheritanceTypes = array(
+        self::INHERITANCE_TYPE_NONE,
+        self::INHERITANCE_TYPE_JOINED,
+        self::INHERITANCE_TYPE_SINGLE_TABLE,
+        self::INHERITANCE_TYPE_TABLE_PER_CLASS
+    );
+    
+    /* The Id generator types. TODO: belongs more in a DBAL class */
+    const GENERATOR_TYPE_AUTO = 'auto';
+    const GENERATOR_TYPE_SEQUENCE = 'sequence';
+    const GENERATOR_TYPE_TABLE = 'table';
+    const GENERATOR_TYPE_IDENTITY = 'identity';
+    const GENERATOR_TYPE_NONE = 'none';
+    
+    /**
+     * Id Generator types enumeration.
+     *
+     * @var array
+     */
+    protected static $_generatorTypes = array(
+        self::GENERATOR_TYPE_AUTO,
+        self::GENERATOR_TYPE_SEQUENCE,
+        self::GENERATOR_TYPE_TABLE,
+        self::GENERATOR_TYPE_IDENTITY,
+        self::GENERATOR_TYPE_NONE
+    );
+    
+    /**
+     * The name of the entity class.
      *
      * @var string
@@ -42 +83 @@
      * The name of the entity class that is at the root of the entity inheritance
      * hierarchy. If the entity is not part of an inheritance hierarchy this is the same
-     * as the $_entityName.
+     * as $_entityName.
      *
      * @var string
@@ -57 +98 @@
 
     /**
-     *
-     * @var Doctrine_Connection
+     * The EntityManager.
+     * 
+     * @var Doctrine::ORM::EntityManager
      */
     protected $_em;
@@ -64 +106 @@
     /**
      * The names of the parent classes (ancestors).
+     * 
+     * @var array
      */
     protected $_parentClasses = array();
 
     /**
-     * The names of all subclasses
+     * The names of all subclasses.
+     * 
+     * @var array
      */
     protected $_subClasses = array();
@@ -79 +125 @@
      */
     protected $_identifier = array();
-
-    /**
-     * The identifier type of the class.
-     *
-     * @see Doctrine::IDENTIFIER_* constants
+    
+    /**
+     * The inheritance mapping type used by the class.
+     *
      * @var integer
      */
-    protected $_identifierType;
-
-    /**
-     * The inheritance mapping type used by the class.
-     *
-     *
-     * @var integer
-     */
-    protected $_inheritanceType = Doctrine::INHERITANCE_TYPE_NONE;
+    protected $_inheritanceType = self::INHERITANCE_TYPE_NONE;
+    
+    /**
+     * The Id generator type used by the class.
+     *
+     * @var string
+     */
+    protected $_generatorType = self::GENERATOR_TYPE_NONE;
 
     /**
@@ -103 +147 @@
      * @todo Unify under 'Behaviors'.
      */
-    protected $_behaviors = array();
-
-    /**
-     * An array containing all behavior generators attached to the class.
-     *
-     * @see Doctrine_Record_Generator
-     * @var array $_generators
-     * @todo Unify under 'Behaviors'.
-     */
-    protected $_generators = array();
-
+    //protected $_behaviors = array();
+    
     /**
      * The field mappings of the class.
      * Keys are field names and values are mapping definitions.
      *
-     * The mapping definition array has at least the following values:
-     *
-     *  -- type         the column type, eg. 'integer'
-     *  -- length       the column length, eg. 11
-     *
-     *  additional keys:
-     *  -- notnull      whether or not the column is marked as notnull
-     *  -- values       enum values
-     *  ... many more
+     * The mapping definition array has the following values:
+     * 
+     * - <b>fieldName</b> (string)
+     * The name of the field in the Entity. 
+     * 
+     * - <b>type</b> (string)
+     * The database type of the column. Can be one of Doctrine's portable types.
+     * 
+     * - <b>columnName</b> (string, optional)
+     * The column name. Optional. Defaults to the field name.
+     * 
+     * - <b>length</b> (integer, optional)
+     * The database length of the column. Optional. Defaults to Doctrine's 
+     * default values for the portable types.
+     * 
+     * - <b>id</b> (boolean, optional)
+     * Marks the field as the primary key of the Entity. Multiple fields of an
+     * entity can have the id attribute, forming a composite key.
+     * 
+     * - <b>generatorType</b> (string, optional, requires: id)
+     * The generation type used for the field. Optional. Can only be applied on
+     * fields that are marked with the 'id' attribute. The possible values are:
+     * auto, identity, sequence, table.
+     * 
+     * - <b>generator</b> (array, optional, requires: generationType=table|sequence)
+     * The generator options for a table or sequence generator. Can only be applied
+     * on fields that have a generationType of 'table' or 'sequence'.
+     * 
+     * - <b>nullable</b> (boolean, optional)
+     * Whether the column is nullable. Defaults to TRUE.
+     * 
+     * - <b>columnDefinition</b> (string, optional)
+     * The SQL fragment that is used when generating the DDL for the column.
+     * 
+     * - <b>precision</b> (integer, optional)
+     * The precision of a decimal column. Only valid if the column type is decimal.
+     * 
+     * - <b>scale</b> (integer, optional)
+     * The scale of a decimal column. Only valid if the column type is decimal.
      *
      * @var array
@@ -138 +203 @@
      * @TODO Implementation (Value Object support)
      */
-    protected $_mappedEmbeddedValues = array();
+    //protected $_embeddedValueMappings = array();
 
     /**
@@ -182 +247 @@
 
     /**
-     * Caches enum value mappings. Keys are field names and values arrays with the
-     * mapping.
-     */
-    protected $_enumValues = array();
-
-    /**
-     * Tree object associated with the class.
-     *
-     * @var Doctrine_Tree
-     * @todo Belongs to the NestedSet Behavior plugin.
-     */
-    protected $_tree;
-
-    /**
-     * Cached column count, Doctrine_Entity uses this column count when
-     * determining its state.
-     *
-     * @var integer
-     */
-    //protected $_columnCount;
-
-    /**
-     * Whether or not this class has default values.
-     *
-     * @var boolean
-     */
-    protected $_hasDefaultValues;
-
-    /**
      * Relation parser object. Manages the relations for the class.
      *
      * @var Doctrine_Relation_Parser $_parser
+     * @todo Remove.
      */
     protected $_parser;
-
-    /**
-     * Enum value arrays.
-     */
-    protected $_enumMap = array();
-
-    /**
-     * @var array $options                  an array containing all options
-     *
-     *      -- treeImpl                     the tree implementation of this table (if any)
-     *
-     *      -- treeOptions                  the tree options
-     *
-     *      -- queryParts                   the bound query parts
-     */
-    protected $_options = array(
-            'treeImpl'    => null,
-            'treeOptions' => null,
-            'queryParts'  => array()
-    );
 
     /**
@@ -277 +294 @@
             'checks'         => array()
     );
-
-    /**
-     * @var array $_invokedMethods              method invoker cache
-     */
-    protected $_invokedMethods = array();
     
     /**
@@ -305 +317 @@
     protected $_lifecycleListeners = array();
     
+    /**
+     * The association mappings.
+     *
+     * @var array
+     */
+    protected $_associationMappings = array();
+    
+    /**
+     * Flag indicating whether the identifier/primary key of the class is composite.
+     *
+     * @var boolean
+     */
+    protected $_isIdentifierComposite = false;
 
     /**
@@ -316 +341 @@
         $this->_rootEntityName = $entityName;
         $this->_em = $em;
+        
         $this->_parser = new Doctrine_Relation_Parser($this);
     }
 
     /**
-     *
+     * @deprecated
      */
     public function getConnection()
@@ -371 +397 @@
     public function isIdentifier($fieldName)
     {
-        if ($this->_identifierType != Doctrine::IDENTIFIER_COMPOSITE) {
+        if ( ! $this->_isIdentifierComposite) {
             return $fieldName === $this->_identifier[0];
         }
@@ -378 +404 @@
 
     /**
-     * Check if the field is unique
+     * Check if the class has a composite identifier.
      *
      * @param string $fieldName  The field name
-     * @return boolean  TRUE if the field is unique, FALSE otherwise.
+     * @return boolean  TRUE if the identifier is composite, FALSE otherwise.
      */
     public function isIdentifierComposite()
     {
-        return $this->_identifierType == Doctrine::IDENTIFIER_COMPOSITE;
+        return $this->_isIdentifierComposite;
     }
 
@@ -491 +517 @@
     }
 
-    public function getBehaviorForMethod($method)
+    /*public function getBehaviorForMethod($method)
     {
         return (isset($this->_invokedMethods[$method])) ?
@@ -499 +525 @@
     {
         $this->_invokedMethods[$method] = $class;
-    }
-
-    /**
-     * getOption
+    }*/
+
+    /**
      * returns the value of given option
      *
@@ -563 +588 @@
     public function getFieldMapping($fieldName)
     {
-        return isset($this->_fieldMappings[$fieldName]) ?
-                $this->_fieldMappings[$fieldName] : false;
+        if ( ! isset($this->_fieldMappings[$fieldName])) {
+            throw Doctrine_MappingException::mappingNotFound($fieldName);
+        }
+        
+        return $this->_fieldMappings[$fieldName];
     }
     
@@ -576 +604 @@
     public function getAssociationMapping($fieldName)
     {
-        //...
+        if ( ! isset($this->_associationMappings[$fieldName])) {
+            throw Doctrine_MappingException::mappingNotFound($fieldName);
+        }
+        
+        return $this->_associationMappings[$fieldName];
+    }
+    
+    /**
+     * Gets all association mappings of the class.
+     *
+     * @return array
+     */
+    public function getAssociationMappings()
+    {
+        return $this->_associationMappings;
     }
 
@@ -627 +669 @@
      * 
      * @return string  The field name.
-     * @throws Doctrine::ORM::Exceptions::ClassMetadataException if the field name could
+     * @throws Doctrine::ORM::Exceptions::ClassMetadataException If the field name could
      *         not be found.
      */
@@ -650 +692 @@
         throw new Doctrine_ClassMetadata_Exception("No field name found for column name '$lcColumnName' during lookup.");
     }
-
-    /**
-     * Maps a field of the class to a database column.
-     *
-     * @param string $name      The name of the column to map. Syntax: columnName [as propertyName].
-     *                          The property name is optional. If not used the column will be
-     *                          mapped to a property with the same name.
-     * @param string $type      The type of the column.
-     * @param integer $length   The length of the column.
-     * @param mixed $options
-     * @param boolean $prepend  Whether to prepend or append the new column to the column list.
-     *                          By default the column gets appended.
-     *
-     * @throws Doctrine_ClassMetadata_Exception If trying use wrongly typed parameter.
-     * @todo Rename to mapField()/addFieldMapping().
-     */
-    public function mapColumn($name, $type, $length = null, $options = array())
-    {
-        // converts 0 => 'primary' to 'primary' => true etc.
-        foreach ($options as $k => $option) {
-            if (is_numeric($k)) {
-                if ( ! empty($option) && $option !== false) {
-                    $options[$option] = true;
+    
+    /**
+     * Adds a field mapping.
+     *
+     * @param array $mapping
+     */
+    public function mapField(array $mapping)
+    {
+        $mapping = $this->_validateAndCompleteFieldMapping($mapping);
+        if (isset($this->_fieldMappings[$mapping['fieldName']])) {
+            throw Doctrine_MappingException::duplicateFieldMapping();
+        }
+        $this->_fieldMappings[$mapping['fieldName']] = $mapping;
+    }
+    
+    /**
+     * Overrides an existant field mapping.
+     * Used i.e. by Entity classes deriving from another Entity class that acts
+     * as a mapped superclass to refine the basic mapping.
+     *
+     * @param array $newMapping
+     * @todo Implementation.
+     */
+    public function overrideFieldMapping(array $newMapping)
+    {
+        //...
+    }
+    
+    /**
+     * Validates & completes the field mapping. Default values are applied here.
+     *
+     * @param array $mapping
+     * @return array
+     */
+    private function _validateAndCompleteFieldMapping(array $mapping)
+    {
+        // Check mandatory fields
+        if ( ! isset($mapping['fieldName'])) {
+            throw Doctrine_MappingException::missingFieldName();
+        }
+        if ( ! isset($mapping['type'])) {
+            throw Doctrine_MappingException::missingType();
+        }
+        
+        // Complete fieldName and columnName mapping
+        if ( ! isset($mapping['columnName'])) {
+            $mapping['columnName'] = $mapping['fieldName'];
+        }
+        $lcColumnName = strtolower($mapping['columnName']);
+
+        $this->_columnNames[$mapping['fieldName']] = $mapping['columnName'];
+        $this->_fieldNames[$mapping['columnName']] = $mapping['fieldName'];
+        $this->_lcColumnToFieldNames[$lcColumnName] = $mapping['fieldName'];
+        
+        // Complete length mapping
+        if ( ! isset($mapping['length'])) {
+            $mapping['length'] = $this->_getDefaultLength($mapping['type']);
+        }
+        
+        // Complete id mapping
+        if (isset($mapping['id']) && $mapping['id'] === true) {
+            if ( ! in_array($mapping['fieldName'], $this->_identifier)) {
+                $this->_identifier[] = $mapping['fieldName'];
+            }
+            if (isset($mapping['generatorType'])) {
+                if ( ! in_array($mapping['generatorType'], self::$_generatorTypes)) {
+                    throw Doctrine_MappingException::invalidGeneratorType($mapping['generatorType']);
+                } else if (count($this->_identifier) > 1) {
+                    throw Doctrine_MappingException::generatorNotAllowedWithCompositeId();
                 }
-                unset($options[$k]);
+                $this->_generatorType = $mapping['generatorType'];
             }
-        }
-
-        // extract column name & field name & lowercased column name
-        $parts = explode(' as ', $name);
-        if (count($parts) > 1) {
-            $fieldName = $parts[1];
-        } else {
-            $fieldName = $parts[0];
-        }
-        $columnName = $parts[0];
-        $lcColumnName = strtolower($parts[0]);
-
-        if (isset($this->_fieldMappings[$fieldName])) {
-            return;
-        }
-
-        // Fill column name <-> field name lookup maps
-        $this->_columnNames[$fieldName] = $columnName;
-        $this->_fieldNames[$columnName] = $fieldName;
-        $this->_lcColumnToFieldNames[$lcColumnName] = $fieldName;
-        $this->_lcColumnToFieldNames[$lcColumnName] = $fieldName;
+            // TODO: validate/complete 'generator' mapping
+            
+            // Check for composite key
+            if ( ! $this->_isIdentifierComposite && count($this->_identifier) > 1) {
+                $this->_isIdentifierComposite = true;
+            }
+            
+        }
         
-        
-        // Inspect & fill $options
-        
-        if ($length == null) {
-            $length = $this->_getDefaultLength($type);
-        }
-
-        $options['type'] = $type;
-        $options['length'] = $length;
-        
-        if ( ! $this->_hasDefaultValues && isset($options['default'])) {
-            $this->_hasDefaultValues = true;
-        }
-        if ( ! empty($options['primary'])) {
-            if ( ! in_array($fieldName, $this->_identifier)) {
-                $this->_identifier[] = $fieldName;
-            }
-            /*if (isset($options['autoincrement']) && $options['autoincrement'] === true) {
-                
-            }*/
-        }
-        /*
-        if ( ! isset($options['immutable'])) {
-            $options['immutable'] = false;
-        }*/
-
-        $this->_fieldMappings[$fieldName] = $options;
-
-        $this->_columnCount++;
-    }
-    
-    /**
-     * Gets the default length for a field type.
-     *
-     * @param unknown_type $type
-     * @return unknown
+        return $mapping;
+    }
+    
+    /**
+     * Gets the default length for a column type.
+     *
+     * @param string $type
+     * @return mixed
      */
     private function _getDefaultLength($type)
@@ -778 +825 @@
      * @return array  The names of all validators that are applied on the specified field.
      */
-    public function getFieldValidators($fieldName)
+    /*public function getFieldValidators($fieldName)
     {
         return isset($this->_fieldMappings[$fieldName]['validators']) ?
                 $this->_fieldMappings[$fieldName]['validators'] : array();
-    }
-
-    /**
-     * Checks whether the mapped class has a default value on any field.
-     *
-     * @return boolean  TRUE if the entity has a default value on any field, otherwise false.
-     */
-    /*public function hasDefaultValues()
-    {
-        return $this->_hasDefaultValues;
-    }*/
-
-    /**
-     * getDefaultValueOf
-     * returns the default value(if any) for given field
-     *
-     * @param string $fieldName
-     * @return mixed
-     */
-    /*public function getDefaultValueOf($fieldName)
-    {
-        if ( ! isset($this->_fieldMappings[$fieldName])) {
-            throw new Doctrine_Table_Exception("Couldn't get default value. Column ".$fieldName." doesn't exist.");
-        }
-        if (isset($this->_fieldMappings[$fieldName]['default'])) {
-            return $this->_fieldMappings[$fieldName]['default'];
-        } else {
-            return null;
-        }
     }*/
 
@@ -833 +851 @@
         return $this->_identifier;
     }
+    
+    /**
+     * Gets the name of the single id field. Note that this only works on
+     * entity classes that have a single-field pk.
+     *
+     * @return string
+     */
+    public function getSingleIdentifierFieldName()
+    {
+        if ($this->_isIdentifierComposite) {
+            throw new Doctrine_Exception("Calling getSingleIdentifierFieldName "
+                    . "on a class that uses a composite identifier is not allowed.");