Changeset 4628 for trunk/lib/Doctrine

Timestamp:

07/04/08 17:32:19 (6 months ago)

Author:

romanb

Message:

The usual 2.0 refactoring/implementation commit.

Location:

trunk/lib/Doctrine

Files:

• ClassMetadata.php (modified) (9 diffs)
• Collection.php (modified) (17 diffs)
• Configuration.php (modified) (1 diff)
• Connection.php (modified) (23 diffs)
• Connection/Mock.php (modified) (1 diff)
• Connection/Mysql.php (modified) (2 diffs)
• Connection/Sqlite.php (modified) (5 diffs)
• Connection/UnitOfWork.php (modified) (8 diffs)
• ConnectionFactory.php (modified) (2 diffs)
• EntityManager.php (modified) (8 diffs)
• EntityManagerFactory.php (modified) (5 diffs)
• EntityPersister/Standard.php (modified) (1 diff)
• EventListener.php (modified) (1 diff)
• EventManager.php (modified) (2 diffs)
• Exception.php (modified) (1 diff)
• HydratorNew.php (modified) (2 diffs)
• Manager.php (modified) (1 diff)
• Query.php (modified) (4 diffs)
• Query/Abstract.php (modified) (1 diff)
• Query/Exception.php (modified) (2 diffs)
• Sequence.php (modified) (1 diff)
• Transaction.php (modified) (1 diff)

trunk/lib/Doctrine/ClassMetadata.php

@@ -142 +142 @@
 
     /**
+     * Enter description here...
+     *
+     * @var array
+     */
+    protected $_attributes = array('loadReferences' => true);
+    
+    /**
      * An array of field names. used to look up field names from column names.
      * Keys are column names and values are field names.
@@ -149 +156 @@
      */
     protected $_fieldNames = array();
-    
-    /**
-     * Enter description here...
-     *
-     * @var unknown_type
-     */
-    protected $_attributes = array('loadReferences' => true);
 
     /**
@@ -167 +167 @@
     
     /**
+     * Map that maps lowercased column names to field names.
+     * Mainly used during hydration because Doctrine enforces PDO_CASE_LOWER
+     * for portability.
+     *
+     * @var array
+     */
+    protected $_lcColumnToFieldNames = array();
+    
+    /**
      * Enter description here...
      *
      * @var unknown_type
      */
-    protected $_subclassFieldNames = array();
+    //protected $_subclassFieldNames = array();
 
     /**
@@ -193 +202 @@
      * @var integer
      */
-    protected $_columnCount;
+    //protected $_columnCount;
 
     /**
@@ -541 +550 @@
 
     /**
-     * getFieldName
-     *
-     * returns the field name for a column name
-     * if no field name can be found the column name is returned.
+     * Gets the field name for a column name.
+     * If no field name can be found the column name is returned.
      *
      * @param string $columnName    column name
@@ -556 +563 @@
     
     /**
+     * Gets the field name for a completely lowercased column name.
+     * Mainly used during hydration.
+     *
+     * @param string $lcColumnName
+     * @return string
+     */
+    public function getFieldNameForLowerColumnName($lcColumnName)
+    {
+        return isset($this->_lcColumnToFieldNames[$lcColumnName]) ?
+                $this->_lcColumnToFieldNames[$lcColumnName] : $lcColumnName;
+    }
+    
+    public function hasLowerColumn($lcColumnName)
+    {
+        return isset($this->_lcColumnToFieldNames[$lcColumnName]);
+    }
+    
+    /**
+     * Looks up the field name for a (lowercased) column name.
      * 
-     */
-    public function lookupFieldName($columnName)
-    {
-        if (isset($this->_fieldNames[$columnName])) {
-            return $this->_fieldNames[$columnName];
-        } else if (isset($this->_subclassFieldNames[$columnName])) {
-            return $this->_subclassFieldNames[$columnName];
-        }
+     * This is mostly used during hydration, because we want to make the
+     * conversion to field names while iterating over the result set for best
+     * performance. By doing this at that point, we can avoid re-iterating over
+     * the data just to convert the column names to field names.
+     * 
+     * However, when this is happening, we don't know the real
+     * class name to instantiate yet (the row data may target a sub-type), hence
+     * this method looks up the field name in the subclass mappings if it's not
+     * found on this class mapping.
+     * This lookup on subclasses is costly but happens only *once* for a column
+     * during hydration because the hydrator caches effectively.
+     */
+    public function lookupFieldName($lcColumnName)
+    {
+        if (isset($this->_lcColumnToFieldNames[$lcColumnName])) {
+            return $this->_lcColumnToFieldNames[$lcColumnName];
+        }/* else if (isset($this->_subclassFieldNames[$lcColumnName])) {
+            return $this->_subclassFieldNames[$lcColumnName];
+        }*/
         
-        $classMetadata = $this;
-        $conn = $this->_em;
-        
-        foreach ($classMetadata->getSubclasses() as $subClass) {
-            $subClassMetadata = $conn->getClassMetadata($subClass);
-            if ($subClassMetadata->hasColumn($columnName)) {
-                $this->_subclassFieldNames[$columnName] = $subClassMetadata->getFieldName($columnName);
-                return $this->_subclassFieldNames[$columnName];
+        foreach ($this->getSubclasses() as $subClass) {
+            $subClassMetadata = $this->_em->getClassMetadata($subClass);
+            if ($subClassMetadata->hasLowerColumn($lcColumnName)) {
+                /*$this->_subclassFieldNames[$lcColumnName] = $subClassMetadata->
+                        getFieldNameForLowerColumnName($lcColumnName);
+                return $this->_subclassFieldNames[$lcColumnName];*/
+                return $subClassMetadata->getFieldNameForLowerColumnName($lcColumnName);
             }
         }
 
-        throw new Doctrine_ClassMetadata_Exception("No field name found for column name '$columnName' during lookup.");
+        throw new Doctrine_ClassMetadata_Exception("No field name found for column name '$lcColumnName' during lookup.");
     }
 
@@ -616 +652 @@
         }
 
-        // extract column name & field name
+        // extract column name & field name & lowercased column name
         $parts = explode(' as ', $name);
         if (count($parts) > 1) {
@@ -623 +659 @@
             $fieldName = $parts[0];
         }
-        $name = strtolower($parts[0]);
-
-        if (isset($this->_columnNames[$fieldName])) {
+        $columnName = $parts[0];
+        $lcColumnName = strtolower($parts[0]);
+
+        if (isset($this->_mappedColumns[$columnName])) {
             return;
         }
 
+        // Fill column name <-> field name lookup maps
         if ($prepend) {
-            $this->_columnNames = array_merge(array($fieldName => $name), $this->_columnNames);
-            $this->_fieldNames = array_merge(array($name => $fieldName), $this->_fieldNames);
+            $this->_columnNames = array_merge(array($fieldName => $columnName), $this->_columnNames);
+            $this->_fieldNames = array_merge(array($columnName => $fieldName), $this->_fieldNames);
         } else {
-            $this->_columnNames[$fieldName] = $name;
-            $this->_fieldNames[$name] = $fieldName;
-        }
+            $this->_columnNames[$fieldName] = $columnName;
+            $this->_fieldNames[$columnName] = $fieldName;
+        }
+        $this->_lcColumnToFieldNames[$lcColumnName] = $fieldName;
+        
         
         // Inspect & fill $options
@@ -663 +703 @@
 
         if ($prepend) {
-            $this->_mappedColumns = array_merge(array($name => $options), $this->_mappedColumns);
+            $this->_mappedColumns = array_merge(array($columnName => $options), $this->_mappedColumns);
         } else {
-            $this->_mappedColumns[$name] = $options;
+            $this->_mappedColumns[$columnName] = $options;
         }
 

trunk/lib/Doctrine/Collection.php

@@ -66 +66 @@
      * @var Doctrine_Entity
      */
-    protected $reference;
+    protected $_owner;
 
     /**
@@ -94 +94 @@
      * @var Doctrine_Null
      */
-    protected static $null;
+    //protected static $null;
+    
+    /**
+     * The EntityManager.
+     *
+     * @var EntityManager
+     */
+    protected $_em;
 
     /**
@@ -105 +112 @@
     public function __construct($entityBaseType, $keyField = null)
     {
-        if (is_string($entityBaseType)) {
-            $this->_entityBaseType = $entityBaseType;
-            $mapper = Doctrine_EntityManagerFactory::getManager($entityBaseType)
-                    ->getEntityPersister($entityBaseType);
-        }
-        $this->_mapper = $mapper;
+        $this->_entityBaseType = $entityBaseType;
+        $this->_em = Doctrine_EntityManagerFactory::getManager($entityBaseType);
+        $this->_mapper = $this->_em->getEntityPersister($entityBaseType);
 
         if ($keyField === null) {
-            $keyField = $mapper->getClassMetadata()->getBoundQueryPart('indexBy');
+            $keyField = $this->_mapper->getClassMetadata()->getBoundQueryPart('indexBy');
         }
 
@@ -126 +130 @@
             $this->_keyField = $keyField;
         }
-    }
-
-    /**
-     * initNullObject
-     * Initializes the null object for this collection.
-     *
-     * @return void
-     */
-    public static function initNullObject(Doctrine_Null $null)
-    {
-        self::$null = $null;
-    }
-
-    /**
-     * getTable
-     * Returns the table of the mapper of the collection.
-     *
-     * @return Doctrine_Table
-     */
-    public function getTable()
-    {
-        return $this->_mapper->getTable();
-    }
-    
-    /**
-     * getMapper
-     * Returns the mapper of this collection.
-     *
-     * @return Doctrine_Mapper
-     */
-    public function getMapper()
-    {
-        return $this->_mapper;
     }
 
@@ -307 +278 @@
     
     /**
-     * setReference
+     * INTERNAL:
      * sets a reference pointer
      *
      * @return void
      */
-    public function setReference(Doctrine_Entity $record, Doctrine_Relation $relation)
-    {
-        $this->reference = $record;
+    public function setReference(Doctrine_Entity $entity, Doctrine_Relation $relation)
+    {
+        $this->_owner = $entity;
         $this->relation  = $relation;
 
@@ -320 +291 @@
                 $relation instanceof Doctrine_Relation_LocalKey) {
             $this->referenceField = $relation->getForeignFieldName();
-            $value = $record->get($relation->getLocalFieldName());
-            foreach ($this->data as $record) {
+            $value = $entity->get($relation->getLocalFieldName());
+            foreach ($this->data as $entity) {
                 if ($value !== null) {
-                    $record->set($this->referenceField, $value, false);
+                    $entity->set($this->referenceField, $value, false);
                 } else {
-                    $record->set($this->referenceField, $this->reference, false);
+                    $entity->set($this->referenceField, $this->_owner, false);
                 }
             }
@@ -334 +305 @@
 
     /**
+     * INTERNAL:
      * getReference
      *
@@ -340 +312 @@
     public function getReference()
     {
-        return $this->reference;
-    }
-
-    /**
-     * remove
-     * removes a specified collection element
+        return $this->_owner;
+    }
+
+    /**
+     * Removes an entity from the collection.
      *
      * @param mixed $key
@@ -358 +329 @@
 
     /**
-     * contains
-     * whether or not this collection contains a specified element
+     * Checks whether the collection contains an entity.
      *
      * @param mixed $key                    the key of the element
@@ -379 +349 @@
 
     /**
-     * get
      * returns a record for given key
-     *
-     * There are two special cases:
-     *
-     * 1. if null is given as a key a new record is created and attached
-     * at the end of the collection
-     *
-     * 2. if given key does not exist, then a new record is create and attached
-     * to the given key
      *
      * Collection also maps referential information to newly created records
@@ -397 +358 @@
     public function get($key)
     {
-        if ( ! isset($this->data[$key])) {
-            $record = $this->_mapper->create();
-
-            if (isset($this->referenceField)) {
-                $value = $this->reference->get($this->relation->getLocalFieldName());
-
-                if ($value !== null) {
-                    $record->set($this->referenceField, $value, false);
-                } else {
-                    $record->set($this->referenceField, $this->reference, false);
-                }
-            }
-            
-            if ($key === null) {
-                $this->data[] = $record;
-            } else {
-                $this->data[$key] = $record;            
-            }
-
-            if (isset($this->_keyField)) {
-                $record->set($this->_keyField, $key);
-            }
-
-            return $record;
-        }
-
-        return $this->data[$key];
+        if (isset($this->data[$key])) {
+            return $this->data[$key];
+        }
+        return null;
     }
 
@@ -492 +430 @@
      *           to adhere to the Doctrine_Access::set() signature.
      */
-    public function set($key, $record)
-    {
-        if ( ! $record instanceOf Doctrine_Entity) {
+    public function set($key, $entity)
+    {
+        if ( ! $entity instanceof Doctrine_Entity) {
             throw new Doctrine_Collection_Exception('Value variable in set is not an instance of Doctrine_Entity');
         }
 
         if (isset($this->referenceField)) {
-            $record->set($this->referenceField, $this->reference, false);
-        }
-        $this->data[$key] = $record;
+            $entity->set($this->referenceField, $this->_owner, false);
+        }
+        $this->data[$key] = $entity;
     }
 
@@ -518 +456 @@
 
         if (isset($this->referenceField)) {
-            $value = $this->reference->get($this->relation->getLocalFieldName());
+            $value = $this->_owner->get($this->relation->getLocalFieldName());
 
             if ($value !== null) {
                 $record->set($this->referenceField, $value, false);
             } else {
-                $record->set($this->referenceField, $this->reference, false);
+                $record->set($this->referenceField, $this->_owner, false);
             }
         }
@@ -560 +498 @@
 
     /**
+     * INTERNAL:
      * loadRelated
      *
@@ -579 +518 @@
                 }
             }
-            $query->from($this->_mapper->getComponentName() . '(' . implode(", ",$this->_mapper->getTable()->getPrimaryKeys()) . ')');
-            $query->where($this->_mapper->getComponentName() . '.id IN (' . substr(str_repeat("?, ", count($list)),0,-2) . ')');
+            $query->from($this->_mapper->getComponentName()
+                    . '(' . implode(", ",$this->_mapper->getTable()->getPrimaryKeys()) . ')');
+            $query->where($this->_mapper->getComponentName()
+                    . '.id IN (' . substr(str_repeat("?, ", count($list)),0,-2) . ')');
 
             return $query;
@@ -608 +549 @@
 
     /**
+     * INTERNAL:
      * populateRelated
      *
@@ -930 +872 @@
         $this->data = array();
 
-        if ($this->reference) {
-            $this->reference->free($deep);
-            $this->reference = null;
+        if ($this->_owner) {
+            $this->_owner->free($deep);
+            $this->_owner = null;
         }
     }

trunk/lib/Doctrine/Configuration.php

@@ -28 +28 @@
  * It combines all configuration options from DBAL & ORM.
  *
+ * @author Roman Borschel <roman@code-factory.org>
  * @since 2.0
  */

trunk/lib/Doctrine/Connection.php

@@ -79 +79 @@
      * The PDO database handle. 
      *
-     * @var PDO
-     * @todo Rename to $pdo.              
-     */
-    protected $dbh;
+     * @var PDO           
+     */
+    protected $_pdo;
     
     /**
@@ -117 +116 @@
      * @var string $driverName                  
      */
-    protected $driverName;
+    protected $_driverName;
     
     /**
@@ -124 +123 @@
      * @var boolean $isConnected                
      */
-    protected $isConnected = false;
+    protected $_isConnected = false;
     
     /**
@@ -164 +163 @@
      * @var array $availableDrivers         
      */
-    private static $availableDrivers = array(
+    private static $_availableDrivers = array(
             'Mysql', 'Pgsql', 'Oracle', 'Informix', 'Mssql', 'Sqlite', 'Firebird'
             );
@@ -173 +172 @@
      * @var integer
      */
-    protected $_count = 0;
+    protected $_queryCount = 0;
 
     
@@ -221 +220 @@
      * Constructor.
      *
-     * @param Doctrine_Manager $manager                 the manager object
-     * @param PDO|Doctrine_Adapter_Interface $adapter   database driver
+     * @param array $params  The connection parameters.
      */
     public function __construct(array $params)
     {
         if (isset($params['pdo'])) {
-            $this->dbh = $params['pdo'];
-            $this->isConnected = true;
+            $this->_pdo = $params['pdo'];
+            $this->_isConnected = true;
         }
         $this->_params = $params;
@@ -320 +318 @@
 
     /**
-     * getDriverName
-     *
      * Gets the name of the instance driver
      *
@@ -328 +324 @@
     public function getDriverName()
     {
-        return $this->driverName;
+        return $this->_driverName;
     }
     
@@ -335 +331 @@
      *
      * @return PDO              the database handler
+     * @deprecated
      */
     public function getDbh()
     {
-        //$this->connect();
-        
-        return $this->dbh;
+        $this->connect();
+        return $this->_pdo;
+    }
+    
+    /**
+     * Gets the PDO handle used by the connection.
+     *
+     * @return PDO
+     */
+    public function getPdo()
+    {
+        $this->connect();
+        return $this->_pdo;
     }
     
@@ -350 +357 @@
     public function connect()
     {
-        if ($this->isConnected) {
+        if ($this->_isConnected) {
             return false;
         }
@@ -357 +364 @@
         //$this->getListener()->preConnect($event);
 
-        $e = explode(':', $this->options['dsn']);
+        // TODO: the extension_loaded check can happen earlier, maybe in the factory
         if (extension_loaded('pdo')) {
-            if (in_array($e[0], PDO::getAvailableDrivers())) {
-                $this->dbh = new PDO(
-                        $this->options['dsn'], $this->options['username'],
-                        $this->options['password'], $this->options['other']);
-                $this->dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
-                $this->dbh->setAttribute(PDO::ATTR_CASE, PDO::CASE_LOWER);
-            }
+            $driverOptions = isset($this->_params['driverOptions']) ?
+                    $this->_params['driverOptions'] : array();
+            $user = isset($this->_params['user']) ?
+                    $this->_params['user'] : null;
+            $password = isset($this->_params['password']) ?
+                    $this->_params['password'] : null;
+            $this->_pdo = new PDO(
+                    $this->_constructPdoDsn(),
+                    $user,
+                    $password,
+                    $driverOptions
+                    );
+            $this->_pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+            $this->_pdo->setAttribute(PDO::ATTR_CASE, PDO::CASE_LOWER);