Changeset 4776 for trunk/lib/Doctrine

Timestamp:

08/16/08 20:40:59 (5 months ago)

Author:

romanb

Message:

continued refactorings.

Location:

trunk/lib/Doctrine

Files:

• Access.php (modified) (1 diff)
• Association.php (modified) (17 diffs)
• Association/OneToOne.php (modified) (1 diff)
• ClassMetadata.php (modified) (32 diffs)
• ClassMetadata/Factory.php (modified) (5 diffs)
• Collection.php (modified) (38 diffs)
• CollectionPersister (added)
• CollectionPersister/Abstract.php (added)
• CollectionPersister/OneToManyPersister.php (added)
• Connection/UnitOfWork.php (modified) (6 diffs)
• DatabasePlatform.php (modified) (2 diffs)
• DatabasePlatform/MySqlPlatform.php (modified) (1 diff)
• DatabasePlatform/OraclePlatform.php (modified) (1 diff)
• Entity.php (modified) (25 diffs)
• EntityManager.php (modified) (16 diffs)
• EntityPersister/Abstract.php (modified) (4 diffs)
• EntityPersister/Standard.php (modified) (2 diffs)
• EventManager.php (modified) (2 diffs)
• Exception.php (modified) (1 diff)
• Hydrator/RecordDriver.php (modified) (1 diff)
• HydratorNew.php (modified) (2 diffs)
• MappingException.php (modified) (2 diffs)
• Query/CacheHandler.php (modified) (2 diffs)
• Query/Production/Join.php (modified) (2 diffs)
• Query/Production/PathExpression.php (modified) (1 diff)
• Query/Production/PathExpressionEndingWithAsterisk.php (modified) (1 diff)
• Query/Production/RangeVariableDeclaration.php (modified) (3 diffs)
• Relation.php (modified) (1 diff)
• Relation/Parser.php (modified) (1 diff)
• Schema/MsSqlSchemaManager.php (modified) (1 diff)

trunk/lib/Doctrine/Access.php

@@ -35 +35 @@
  * @version     $Revision$
  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
- * @todo Consider making Collection & Entity implement ArrayAccess directly.
- *       This base class is not really a huge benefit.
+ * @todo Remove.
  */
 abstract class Doctrine_Access implements ArrayAccess

trunk/lib/Doctrine/Association.php

@@ -25 +25 @@
  * Base class for association mappings.
  *
+ * @author Roman Borschel <roman@code-factory.org>
  * @since 2.0
- * @author Roman Borschel <roman@code-factory.org>
  * @todo Rename to AssociationMapping.
  */
@@ -53 +53 @@
     protected $_isCascadeRefresh;
     
+    protected $_customAccessor;
+    protected $_customMutator;
+    
     /**
      * The fetch mode used for the association.
@@ -69 +72 @@
     
     /**
+     * Whether the association is optional (0..X) or not (1..X).
+     * By default all associations are optional.
+     *
+     * @var boolean
+     */
+    protected $_isOptional = true;
+    
+    /**
      * The name of the source Entity (the Entity that defines this mapping).
      *
@@ -85 +96 @@
     /**
      * Identifies the field on the source class (the class this AssociationMapping
-     * belongs to) that represents the association.
+     * belongs to) that represents the association and stores the reference to the
+     * other entity/entities.
      *
      * @var string
@@ -107 +119 @@
     public function __construct(array $mapping)
     {
-        $this->_validateMapping($mapping);
-        if ($this->_isOwningSide) {
-            $this->_sourceEntityName = $mapping['sourceEntity'];
-            $this->_targetEntityName = $mapping['targetEntity'];
-            $this->_sourceFieldName = $mapping['fieldName'];
-        } else {
+        $this->_validateAndCompleteMapping($mapping);
+        
+        $this->_sourceEntityName = $mapping['sourceEntity'];
+        $this->_targetEntityName = $mapping['targetEntity'];
+        $this->_sourceFieldName = $mapping['fieldName'];
+        
+        if ( ! $this->_isOwningSide) {
             $this->_mappedByFieldName = $mapping['mappedBy'];
         }        
@@ -123 +136 @@
      * @return array  The validated & completed mapping.
      */
-    protected function _validateMapping(array $mapping)
-    {
+    protected function _validateAndCompleteMapping(array $mapping)
+    {        
         if (isset($mapping['mappedBy'])) {
+            // Inverse side, mapping can be found on the owning side.
             $this->_isOwningSide = false;
-        }
-        
-        if ($this->_isOwningSide) {
-            if ( ! isset($mapping['targetEntity'])) {
-                throw Doctrine_MappingException::missingTargetEntity();
-            } else if ( ! isset($mapping['fieldName'])) {
-                throw Doctrine_MappingException::missingFieldName();
-            }
-        }
+        } else {
+            // Owning side
+        }
+        
+        // Mandatory attributes
+        if ( ! isset($mapping['fieldName'])) {
+            throw Doctrine_MappingException::missingFieldName();
+        }
+        if ( ! isset($mapping['sourceEntity'])) {
+            throw Doctrine_MappingException::missingSourceEntity($mapping['fieldName']);
+        }
+        if ( ! isset($mapping['targetEntity'])) {
+            throw Doctrine_MappingException::missingTargetEntity($mapping['fieldName']);
+        }
+        
+        // Optional attributes
+        $this->_customAccessor = isset($mapping['accessor']) ? $mapping['accessor'] : null;
+        $this->_customMutator = isset($mapping['mutator']) ? $mapping['mutator'] : null;
+        $this->_isOptional = isset($mapping['isOptional']) ? (bool)$mapping['isOptional'] : true;
 
         return $mapping;
     }
     
+    protected function _validateAndCompleteInverseSideMapping()
+    {
+        
+    }
+    
+    protected function _validateAndCompleteOwningSideMapping()
+    {
+        
+    }
+    
+    /**
+     * Whether the association cascades delete() operations from the source entity
+     * to the target entity/entities.
+     *
+     * @return boolean
+     */
     public function isCascadeDelete()
     {
@@ -148 +188 @@
     }
     
+    /**
+     * Whether the association cascades save() operations from the source entity
+     * to the target entity/entities.
+     *
+     * @return boolean
+     */
     public function isCascadeSave()
     {
@@ -156 +202 @@
     }
     
+    /**
+     * Whether the association cascades refresh() operations from the source entity
+     * to the target entity/entities.
+     *
+     * @return boolean
+     */
     public function isCascadeRefresh()
     {
@@ -164 +216 @@
     }
     
+    /**
+     * Whether the target entity/entities of the association are eagerly fetched.
+     *
+     * @return boolean
+     */
     public function isEagerlyFetched()
     {
@@ -169 +226 @@
     }
     
+    /**
+     * Whether the target entity/entities of the association are lazily fetched.
+     *
+     * @return boolean
+     */
     public function isLazilyFetched()
     {
@@ -174 +236 @@
     }
     
+    /**
+     * Whether the target entity/entities of the association are manually fetched.
+     *
+     * @return boolean
+     */
     public function isManuallyFetched()
     {
@@ -179 +246 @@
     }
     
+    /**
+     * Whether the source entity of this association represents the owning side.
+     *
+     * @return boolean
+     */
     public function isOwningSide()
     {
@@ -184 +256 @@
     }
     
+    /**
+     * Whether the source entity of this association represents the inverse side.
+     *
+     * @return boolean
+     */
     public function isInverseSide()
     {
@@ -189 +266 @@
     }
     
+    /**
+     * Whether the association is optional (0..X), or not (1..X).
+     *
+     * @return boolean TRUE if the association is optional, FALSE otherwise.
+     */
+    public function isOptional()
+    {
+        return $this->_isOptional;
+    }
+    
+    /**
+     * Gets the name of the source entity class.
+     *
+     * @return string
+     */
     public function getSourceEntityName()
     {
@@ -194 +286 @@
     }
     
+    /**
+     * Gets the name of the target entity class.
+     *
+     * @return string
+     */
     public function getTargetEntityName()
     {
@@ -202 +299 @@
      * Get the name of the field the association is mapped into.
      *
+     * @return string
      */
     public function getSourceFieldName()
@@ -208 +306 @@
     }
     
+    /**
+     * Gets the field name of the owning side in a bi-directional association.
+     *
+     * @return string
+     */
     public function getMappedByFieldName()
     {
         return $this->_mappedByFieldName;
+    }
+    
+    /**
+     * Whether the source field of the association has a custom accessor.
+     *
+     * @return boolean TRUE if the source field of the association has a custom accessor,
+     *                 FALSE otherwise.
+     */
+    public function hasCustomAccessor()
+    {
+        return isset($this->_customAccessor);
+    }
+    
+    /**
+     * Gets the name of the custom accessor method of the source field.
+     *
+     * @return string The name of the accessor method or NULL.
+     */
+    public function getCustomAccessor()
+    {
+        return $this->_customAccessor;
+    }
+    
+    /**
+     * Whether the source field of the association has a custom mutator.
+     *
+     * @return boolean TRUE if the source field of the association has a custom mutator,
+     *                 FALSE otherwise.
+     */
+    public function hasCustomMutator()
+    {
+        return isset($this->_customMutator);
+    }
+    
+    /**
+     * Gets the name of the custom mutator method of the source field.
+     *
+     * @return string The name of the mutator method or NULL.
+     */
+    public function getCustomMutator()
+    {
+        return $this->_customMutator;
+    }
+    
+    public function isOneToOne()
+    {
+        return false;
+    }
+    
+    public function isOneToMany()
+    {
+        return false;
+    }
+    
+    public function isManyToMany()
+    {
+        return false;
     }
     

trunk/lib/Doctrine/Association/OneToOne.php

@@ -107 +107 @@
     
     /**
+     * Whether the association is one-to-one.
+     *
+     * @return boolean
+     * @override
+     */
+    public function isOneToOne()
+    {
+        return true;
+    }
+    
+    /**
      * Lazy-loads the associated entity for a given entity.
      *

trunk/lib/Doctrine/ClassMetadata.php

@@ -49 +49 @@
     
     /* The Entity types */
-    // A regular entity is assumed to have persistent state that Doctrine should manage.
+    /**
+     * A regular entity is assumed to have persistent state that Doctrine should manage.
+     */
     const ENTITY_TYPE_REGULAR = 'regular';
-    // A transient entity is ignored by Doctrine.
+    /**
+     * A transient entity is ignored by Doctrine.
+     */
     const ENTITY_TYPE_TRANSIENT = 'transient';
-    // A mapped superclass entity is itself not persisted by Doctrine but it's
-    // field & association mappings are inherited by subclasses.
+    /**
+     * A mapped superclass entity is itself not persisted by Doctrine but it's
+     * field & association mappings are inherited by subclasses.
+     */
     const ENTITY_TYPE_MAPPED_SUPERCLASS = 'mappedSuperclass';
     
@@ -123 +129 @@
      */
     protected $_generatorType = self::GENERATOR_TYPE_NONE;
-
-    /**
-     * An array containing all behaviors attached to the class.
-     *
-     * @see Doctrine_Template
-     * @var array $_templates
-     * @todo Unify under 'Behaviors'.
-     */
-    //protected $_behaviors = array();
     
     /**
@@ -219 +216 @@
      */
     protected $_lcColumnToFieldNames = array();
-    
-    /**
-     * Enter description here...
-     *
-     * @var unknown_type
-     */
-    //protected $_subclassFieldNames = array();
 
     /**
@@ -311 +301 @@
      */
     protected $_isIdentifierComposite = false;
+    
+    protected $_customAssociationAccessors = array();
+    protected $_customAssociationMutators = array();
 
     /**
@@ -316 +309 @@
      *
      * @param string $entityName  Name of the entity class the metadata info is used for.
+     * @param Doctrine::ORM::Entitymanager $em
      */
     public function __construct($entityName, Doctrine_EntityManager $em)
@@ -325 +319 @@
         $this->_parser = new Doctrine_Relation_Parser($this);
     }
-
-    /**
-     * @deprecated
-     */
-    public function getConnection()
-    {
-        return $this->_em;
-    }
-    
+    
+    /**
+     * Gets the EntityManager that holds this ClassMetadata.
+     *
+     * @return Doctrine::ORM::EntityManager
+     */
     public function getEntityManager()
     {
@@ -362 +353 @@
 
     /**
-     * @deprecated
-     */
-    public function getComponentName()
-    {
-        return $this->getClassName();
-    }
-
-    /**
      * Checks whether a field is part of the identifier/primary key field(s).
      *
@@ -430 +413 @@
 
     /**
-     * addIndex
-     *
      * adds an index to this table
      *
@@ -460 +441 @@
 
     /**
-     * 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
-     * @deprecated
-     */
-    public function setOption($name, $value)
-    {
-        $this->_options[$name] = $value;
-    }
-
-    /**
      * Sets a table option.
      */
@@ -496 +461 @@
 
         return $this->_tableOptions[$name];
-    }
-
-    /*public function getBehaviorForMethod($method)
-    {
-        return (isset($this->_invokedMethods[$method])) ?
-        $this->_invokedMethods[$method] : false;
-    }
-    public function addBehaviorMethod($method, $behavior)
-    {
-        $this->_invokedMethods[$method] = $class;
-    }*/
-
-    /**
-     * 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];
-        } else if (isset($this->_tableOptions[$name])) {
-            return $this->_tableOptions[$name];
-        }
-        return null;
-    }
-
-    /**
-     * getOptions
-     * returns all options of this table and the associated values
-     *
-     * @return array    all options and their values
-     */
-    public function getOptions()
-    {
-        return $this->_options;
     }
 
@@ -704 +632 @@
      * Validates & completes the field mapping. Default values are applied here.
      *
-     * @param array $mapping
-     * @return array
+     * @param array $mapping  The field mapping to validated & complete.
+     * @return array  The validated and completed field mapping.
      */
     private function _validateAndCompleteFieldMapping(array $mapping)
@@ -802 +730 @@
 
     /**
-     * Gets the names of all validators that are applied on a field.
-     *
-     * @param string  The field name.
-     * @return array  The names of all validators that are applied on the specified field.
-     */
-    /*public function getFieldValidators($fieldName)
-    {
-        return isset($this->_fieldMappings[$fieldName]['validators']) ?
-                $this->_fieldMappings[$fieldName]['validators'] : array();
-    }*/
-
-    /**
      * Gets the identifier (primary key) field names of the class.
      *
@@ -872 +788 @@
     public function getCustomAccessor($fieldName)
     {
-        return isset($this->_fieldMappings[$fieldName]['accessor']) ?
-                $this->_fieldMappings[$fieldName]['accessor'] : null;
+        if (isset($this->_fieldMappings[$fieldName]['accessor'])) {
+            return $this->_fieldMappings[$fieldName]['accessor'];
+        } else if (isset($this->_customAssociationAccessors[$fieldName])) {
+            return $this->_customAssociationAccessors[$fieldName];
+        }
+        return null;
     }
 
@@ -884 +804 @@
     public function getCustomMutator($fieldName)
     {
-        return isset($this->_fieldMappings[$fieldName]['mutator']) ?
-                $this->_fieldMappings[$fieldName]['mutator'] : null;
+        if (isset($this->_fieldMappings[$fieldName]['mutator'])) {
+            return $this->_fieldMappings[$fieldName]['mutator'];
+        } else if (isset($this->_customAssociationMutators[$fieldName])) {
+            return $this->_customAssociationMutators[$fieldName];
+        }
+        return null;
     }
     
@@ -1055 +979 @@
 
     /**
-     * getBehaviors
-     * returns all behaviors attached to the class.
-     *
-     * @return array     an array containing all templates
-     * @todo Unify under 'Behaviors'
-     */
-    /*public function getBehaviors()
-    {
-        return $this->_behaviors;
-    }*/
-
-    /**
      * Gets the inheritance type used by the class.
      *
@@ -1157 +1069 @@
         }
         
-        if ($type == Doctrine::INHERITANCE_TYPE_SINGLE_TABLE ||
-                $type == Doctrine::INHERITANCE_TYPE_JOINED) {
+        if ($type == self::INHERITANCE_TYPE_SINGLE_TABLE ||
+                $type == self::INHERITANCE_TYPE_JOINED) {
             $this->_checkRequiredDiscriminatorOptions($options);
         }
@@ -1241 +1153 @@
 
     /**
-     * export
      * exports this class to the database based on its mapping.
      *
@@ -1248 +1159 @@
      * @return boolean                          Whether or not the export operation was successful
      *                                          false if table already existed in the database.
+     * @todo Reimpl. & Placement.
      */
     public function export()
     {
-        $this->_em->export->exportTable($this);
-    }
-
-    /**
-     * getExportableFormat
+        //$this->_em->export->exportTable($this);
+    }
+
+    /**
      * Returns an array with all the information needed to create the main database table
      * for the class.
      *
      * @return array
+     * @todo Reimpl. & placement.
      */
     public function getExportableFormat($parseForeignKeys = true)
@@ -1269 +1181 @@
         // If the class is part of a Single Table Inheritance hierarchy, collect the fields
         // of all classes in the hierarchy.
-        if ($this->_inheritanceType == Doctrine::INHERITANCE_TYPE_SINGLE_TABLE) {
+        if ($this->_inheritanceType == self::INHERITANCE_TYPE_SINGLE_TABLE) {
             $parents = $this->getParentClasses();
             if ($parents) {
@@ -1281 +1193 @@
                 $allColumns = array_merge($allColumns, $subClassMetadata->getColumns());
             }
-        } else if ($this->_inheritanceType == Doctrine::INHERITANCE_TYPE_JOINED) {
+        } else if ($this->_inheritanceType == self::INHERITANCE_TYPE_JOINED) {
             // Remove inherited, non-pk fields. They're not in the table of this class
             foreach ($allColumns as $name => $definition) {