Changeset 4655 for trunk/lib/Doctrine

Timestamp:

07/11/08 11:48:04 (6 months ago)

Author:

romanb

Message:

Cleanups, improvements, fixes.

Location:

trunk/lib/Doctrine

Files:

• ClassMetadata.php (modified) (28 diffs)
• ClassMetadata/Factory.php (modified) (2 diffs)
• Entity.php (modified) (3 diffs)
• HydratorNew.php (modified) (13 diffs)
• MappingException.php (added)
• Query/Production/PathExpressionEndingWithAsterisk.php (modified) (1 diff)

trunk/lib/Doctrine/ClassMetadata.php

@@ -541 +541 @@
 
     /**
-     * getColumnName
-     *
-     * returns a column name for a field name.
-     * if the column name for the field cannot be found
-     * this method returns the given field name.
-     *
-     * @param string $alias         column alias
-     * @return string               column name
+     * Gets a column name for a field name.
+     * If the column name for the field cannot be found, the given field name
+     * is returned.
+     *
+     * @param string $alias  The field name.
+     * @return string  The column name.
      */
     public function getColumnName($fieldName)
@@ -557 +555 @@
 
     /**
-     * @deprecated
-     */
-    public function getColumnDefinition($columnName)
-    {
-        return $this->getColumnMapping($columnName);
-    }
-
+     * Gets the mapping of a (regular) fields that holds some data but not a
+     * reference to another object.
+     *
+     * @param string $fieldName  The field name.
+     * @return array  The mapping.
+     */
     public function getFieldMapping($fieldName)
     {
@@ -569 +566 @@
                 $this->_fieldMappings[$fieldName] : false;
     }
+    
+    /**
+     * Gets the mapping of an association.
+     *
+     * @param string $fieldName  The field name that represents the association in
+     *                           the object model.
+     * @return Doctrine::ORM::Mapping::AssociationMapping  The mapping.
+     */
+    public function getAssociationMapping($fieldName)
+    {
+        //...
+    }
 
     /**
@@ -589 +598 @@
      * @param string $lcColumnName
      * @return string
+     * @todo Better name.
      */
     public function getFieldNameForLowerColumnName($lcColumnName)
@@ -642 +652 @@
 
     /**
-     * @deprecated
-     */
-    public function setColumns(array $definitions)
-    {
-        foreach ($definitions as $name => $options) {
-            $this->setColumn($name, $options['type'], $options['length'], $options);
-        }
-    }
-
-    /**
      * Maps a field of the class to a database column.
      *
@@ -664 +664 @@
      *
      * @throws Doctrine_ClassMetadata_Exception If trying use wrongly typed parameter.
+     * @todo Rename to mapField()/addFieldMapping().
      */
     public function mapColumn($name, $type, $length = null, $options = array())
@@ -784 +785 @@
 
     /**
-     * Checks whether the class mapped class has a default value on any field.
+     * 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()
+    /*public function hasDefaultValues()
     {
         return $this->_hasDefaultValues;
-    }
+    }*/
 
     /**
@@ -800 +801 @@
      * @return mixed
      */
-    public function getDefaultValueOf($fieldName)
+    /*public function getDefaultValueOf($fieldName)
     {
         if ( ! isset($this->_fieldMappings[$fieldName])) {
@@ -810 +811 @@
             return null;
         }
-    }
-
-    /**
-     * Gets the identifier (primary key) field(s) of the mapped class.
+    }*/
+
+    /**
+     * Gets the identifier (primary key) field names of the class.
      *
      * @return mixed
@@ -824 +825 @@
 
     /**
-     * Gets the identifier (primary key) field(s) of the mapped class.
+     * Gets the identifier (primary key) field names of the class.
      *
      * @return mixed
@@ -840 +841 @@
     /**
      * Gets the type of the identifier (primary key) used by the mapped class. The type
-     * can be either <tt>Doctrine::IDENTIFIER_NATURAL</tt>, <tt>Doctrine::IDENTIFIER_AUTOINCREMENT</tt>,
-     * <tt>Doctrine::IDENTIFIER_SEQUENCE</tt> or <tt>Doctrine::IDENTIFIER_COMPOSITE</tt>.
+     * can be either
+     * <tt>Doctrine::IDENTIFIER_NATURAL</tt>,
+     * <tt>Doctrine::IDENTIFIER_AUTOINCREMENT</tt>,
+     * <tt>Doctrine::IDENTIFIER_SEQUENCE</tt> or
+     * <tt>Doctrine::IDENTIFIER_COMPOSITE</tt>.
      *
      * @return integer
@@ -856 +860 @@
     {
         $this->_identifierType = $type;
-    }
-
-    /**
-     * hasColumn
-     * @return boolean
-     * @deprecated
-     */
-    public function hasColumn($columnName)
-    {
-        return isset($this->_fieldNames[$columnName]);
     }
 
@@ -886 +880 @@
      * @return array
      */
-    public function getEnumValues($fieldName)
+    /*public function getEnumValues($fieldName)
     {
         if (isset($this->_fieldMappings[$fieldName]['values'])) {
@@ -893 +887 @@
             return array();
         }
-    }
+    }*/
 
     /**
@@ -902 +896 @@
      * @return mixed
      */
-    public function enumValue($fieldName, $index)
+    /*public function enumValue($fieldName, $index)
     {
         if ($index instanceof Doctrine_Null) {
@@ -922 +916 @@
 
         return $enumValue;
-    }
+    }*/
 
     /**
@@ -931 +925 @@
      * @return mixed
      */
-    public function enumIndex($fieldName, $value)
+    /*public function enumIndex($fieldName, $value)
     {
         $values = $this->getEnumValues($fieldName);
@@ -940 +934 @@
 
         return $value;
-    }
+    }*/
 
     /**
@@ -948 +942 @@
      * @deprecated
      */
-    public function getColumnCount()
+    /*public function getColumnCount()
     {
         return $this->_columnCount;
-    }
+    }*/
 
     /**
@@ -958 +952 @@
      * @return integer      the number of mapped columns in the class.
      */
-    public function getMappedColumnCount()
+    public function getMappedFieldCount()
     {
         return $this->_columnCount;
@@ -964 +958 @@
 
     /**
-     *
+     * Gets the custom accessor of a field.
+     * 
      * @return string  The name of the accessor (getter) method or NULL if the field does
      *                 not have a custom accessor.
@@ -975 +970 @@
 
     /**
-     *
+     * Gets the custom mutator of a field.
+     * 
      * @return string  The name of the mutator (setter) method or NULL if the field does
      *                 not have a custom mutator.
@@ -984 +980 @@
                 $this->_fieldMappings[$fieldName]['mutator'] : null;
     }
-
-    /**
-     * returns all columns and their definitions
-     *
-     * @return array
-     * @deprecated
-     */
-    public function getColumns()
-    {
-        return $this->_fieldMappings;
-    }
-
-    /**
-     * Gets all mapped columns and their mapping definitions.
-     *
-     * @return array
-     */
-    public function getMappedColumns()
-    {
-        return $this->_fieldMappings;
-    }
-    
+    
+    /**
+     * Gets all field mappings.
+     *
+     * @return unknown
+     */
     public function getFieldMappings()
     {
@@ -1017 +997 @@
      * @return boolean
      */
-    public function removeColumn($fieldName)
+    /*public function removeColumn($fieldName)
     {
         $columnName = array_search($fieldName, $this->_fieldNames);
@@ -1030 +1010 @@
 
         return false;
-    }
+    }*/
 
     /**
@@ -1077 +1057 @@
      * @deprecated
      */
-    public function getDefinitionOf($fieldName)
+    /*public function getDefinitionOf($fieldName)
     {
         $columnName = $this->getColumnName($fieldName);
 
         return $this->getColumnDefinition($columnName);
-    }
-    
-    /**
-     * Gets the mapping information for a field.
-     *
-     * @param string $fieldName
-     * @return array
-     */
-    public function getMappingForField($fieldName)
-    {
-        return $this->_fieldMappings[$fieldName];
-    }
-
-    /**
-     * getTypeOf
-     *
-     * @return mixed        string on success, false on failure
-     * @deprecated
-     */
-    public function getTypeOf($fieldName)
-    {
-        
-        return $this->getTypeOfColumn($this->getColumnName($fieldName));
-    }
+    }*/
     
     /**
@@ -1162 +1119 @@
     {
         //...
-    }
-
-    public function bindRelation($args, $type)
-    {
-        return $this->bind($args, $type);
-    }
-
-    /**
-     * DESCRIBE WHAT THIS METHOD DOES, PLEASE!
-     *
-     * @todo Name proposal: addRelation
-     */
-    public function bind($args, $type)
-    {
-        $options = array();
-        $options['type'] = $type;
-
-        if ( ! isset($args[1])) {
-            $args[1] = array();
-        }
-        if ( ! is_array($args[1])) {
-            try {
-                throw new Exception();
-            } catch (Exception $e) {
-                echo $e->getTraceAsString();
-            }
-        }
-        $options = array_merge($args[1], $options);
-        $this->_parser->bind($args[0], $options);
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * getRelation
-     *
-     * @param string $alias      relation alias
-     */
-    public function getRelation($alias, $recursive = true)
-    {
-        return $this->_parser->getRelation($alias, $recursive);
-    }
-
-    public function getRelationParser()
-    {
-        return $this->_parser;
-    }
-
-    /**
-     * getRelations
-     * returns an array containing all relation objects
-     *
-     * @return array        an array of Doctrine_Relation objects
-     */
-    public function getRelations()
-    {
-        return $this->_parser->getRelations();
     }
 
@@ -2059 +1950 @@
         }
     }
-
+    
+    /* The following stuff needs to be touched for the association mapping rewrite */
+    
+    public function bindRelation($args, $type)
+    {
+        return $this->bind($args, $type);
+    }
+
+    /**
+     * @todo Relation mapping rewrite.
+     */
+    public function bind($args, $type)
+    {
+        $options = array();
+        $options['type'] = $type;
+
+        if ( ! isset($args[1])) {
+            $args[1] = array();
+        }
+        if ( ! is_array($args[1])) {
+            try {
+                throw new Exception();
+            } catch (Exception $e) {
+                echo $e->getTraceAsString();
+            }
+        }
+        $options = array_merge($args[1], $options);
+        $this->_parser->bind($args[0], $options);
+    }
+
+    /**
+     * 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);
+    }
+
+    /**
+     * getRelation
+     *
+     * @param string $alias      relation alias
+     */
+    public function getRelation($alias, $recursive = true)
+    {
+        return $this->_parser->getRelation($alias, $recursive);
+    }
+
+    public function getRelationParser()
+    {
+        return $this->_parser;
+    }
+
+    /**
+     * getRelations
+     * returns an array containing all relation objects
+     *
+     * @return array        an array of Doctrine_Relation objects
+     */
+    public function getRelations()
+    {
+        return $this->_parser->getRelations();
+    }
 
     /**

trunk/lib/Doctrine/ClassMetadata/Factory.php

@@ -131 +131 @@
     protected function _addInheritedFields($subClass, $parentClass)
     {
-        foreach ($parentClass->getColumns() as $name => $definition) {
+        foreach ($parentClass->getFieldMappings() as $name => $definition) {
             $fullName = "$name as " . $parentClass->getFieldName($name);
             $definition['inherited'] = true;
@@ -247 +247 @@
                 foreach ($class->getIdentifier() as $pk) {
                     $columnName = $class->getColumnName($pk);
-                    $thisColumns = $class->getColumns();
+                    $thisColumns = $class->getFieldMappings();
                     $e = $thisColumns[$columnName];
 

trunk/lib/Doctrine/Entity.php

@@ -343 +343 @@
 
         foreach ($this->_data as $k => $v) {
-            if ($v instanceof Doctrine_Entity && $this->_class->getTypeOf($k) != 'object') {
+            if ($v instanceof Doctrine_Entity && $this->_class->getTypeOfField($k) != 'object') {
                 unset($vars['_data'][$k]);
             } else if ($v === Doctrine_Null::$INSTANCE) {
                 unset($vars['_data'][$k]);
             } else {
-                switch ($this->_class->getTypeOf($k)) {
+                switch ($this->_class->getTypeOfField($k)) {
                     case 'array':
                     case 'object':
@@ -401 +401 @@
 
         foreach ($this->_data as $k => $v) {
-            switch ($this->_class->getTypeOf($k)) {
+            switch ($this->_class->getTypeOfField($k)) {
                 case 'array':
                 case 'object':
@@ -1025 +1025 @@
 
         foreach ($modifiedFields as $field) {
-            $type = $this->_class->getTypeOf($field);
+            $type = $this->_class->getTypeOfField($field);
 
             if ($this->_data[$field] === Doctrine_Null::$INSTANCE) {

trunk/lib/Doctrine/HydratorNew.php

@@ -110 +110 @@
         reset($this->_queryComponents);
         $rootAlias = key($this->_queryComponents);
-        $rootComponentName = $this->_queryComponents[$rootAlias]['metadata']->getClassName();
+        $rootEntityName = $this->_queryComponents[$rootAlias]['metadata']->getClassName();
         // if only one class is involved we can make our lives easier
         $isSimpleQuery = count($this->_queryComponents) <= 1;
@@ -129 +129 @@
             $result = array();
         } else {
-            $result = $driver->getElementCollection($rootComponentName);
+            $result = $driver->getElementCollection($rootEntityName);
         }  
 
@@ -140 +140 @@
             // disable lazy-loading of related elements during hydration
             $component['metadata']->setAttribute('loadReferences', false);
-            $componentName = $component['metadata']->getClassName();
+            $entityName = $component['metadata']->getClassName();
             $identifierMap[$dqlAlias] = array();
             $resultPointers[$dqlAlias] = array();
@@ -164 +164 @@
             }
             
+            // From here on its all about graph construction            
+            
+            // 1) Initialize
             $id = $idTemplate; // initialize the id-memory
             $nonemptyComponents = array();
             $rowData = $this->_gatherRowData($data, $cache, $id, $nonemptyComponents);
 
-            //
-            // hydrate the data of the root entity from the current row
-            //
-            $class = $this->_queryComponents[$rootAlias]['metadata'];
-            $componentName = $class->getComponentName();
+            // 2) Hydrate the data of the root entity from the current row
+            //$class = $this->_queryComponents[$rootAlias]['metadata'];
+            //$entityName = $class->getComponentName();
             
             // Check for an existing element
             $index = false;
             if ($isSimpleQuery || ! isset($identifierMap[$rootAlias][$id[$rootAlias]])) {
-                $element = $driver->getElement($rowData[$rootAlias], $componentName);
-
-                // do we need to index by a custom field?
+                $element = $driver->getElement($rowData[$rootAlias], $rootEntityName);
                 if ($field = $this->_getCustomIndexField($rootAlias)) {
                     if ($parserResult->isMixedQuery()) {
@@ -199 +198 @@
                 $index = $identifierMap[$rootAlias][$id[$rootAlias]];
             }
-            $this->_setLastElement($resultPointers, $result, $index, $rootAlias, false);
+            $this->_updateResultPointer($resultPointers, $result, $index, $rootAlias, false);
             unset($rowData[$rootAlias]);
             // end hydrate data of the root component for the current row
             
-            // Check for scalar values
+            // Extract scalar values. They're appended at the end.
             if (isset($rowData['scalars'])) {
                 $scalars = $rowData['scalars'];
@@ -209 +208 @@
             }
             
-            // now hydrate the rest of the data found in the current row, that belongs to other
-            // (related) classes.
+            // 3) Now hydrate the rest of the data found in the current row, that
+            // belongs to other (related) Entities.
             foreach ($rowData as $dqlAlias => $data) {                
                 $index = false;
                 $map = $this->_queryComponents[$dqlAlias];
-                $componentName = $map['metadata']->getClassName();
+                $entityName = $map['metadata']->getClassName();
                 $parent = $map['parent'];
                 $relation = $map['relation'];
@@ -228 +227 @@
                     $baseElement =& $resultPointers[$parent];
                 } else {
-                    unset($prev[$dqlAlias]); // Ticket #1228
+                    unset($resultPointers[$dqlAlias]); // Ticket #1228
                     continue;
                 }
@@ -242 +241 @@
                         $indexIsValid = $index !== false ? isset($baseElement[$relationAlias][$index]) : false;
                         if ( ! $indexExists || ! $indexIsValid) {
-                            $element = $driver->getElement($data, $componentName);
+                            $element = $driver->getElement($data, $entityName);
                             if ($field = $this->_getCustomIndexField($dqlAlias)) {
                                 $driver->addRelatedIndexedElement($baseElement, $relationAlias, $element, $field);
@@ -253 +252 @@
                     } else if ( ! isset($baseElement[$relationAlias])) {
                         $driver->setRelatedElement($baseElement, $relationAlias,
-                                $driver->getElementCollection($componentName));
+                                $driver->getElementCollection($entityName));
                     }
                 } else {
@@ -264 +263 @@
                     } else if ( ! $driver->isFieldSet($baseElement, $relationAlias)) {
                         $driver->setRelatedElement($baseElement, $relationAlias,
-                                $driver->getElement($data, $componentName));
+                                $driver->getElement($data, $entityName));
                     }
                 }
                 if (($coll =& $driver->getReferenceValue($baseElement, $relationAlias)) !== null) {
-                    $this->_setLastElement($resultPointers, $coll, $index, $dqlAlias, $oneToOne);   
+                    $this->_updateResultPointer($resultPointers, $coll, $index, $dqlAlias, $oneToOne);   
                 }