RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-04-03 13:23:37 +03:00
Code Issues Projects Releases Wiki Activity

Heavily simplified code on simple object hydrator. Code cleanup on column information cache; by reference cache variable is no longer needed and protected variable is used in a standardized way everywhere.

Browse source
This commit is contained in:
Guilherme Blanco 2014-04-25 03:40:54 +00:00
parent e8e86205f5
commit 21437bb276
6 changed files with 78 additions and 111 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
UPGRADE.md
View file

@ -1,5 +1,13 @@
# Upgrade to 2.5 # Upgrade to 2.5
## Minor BC BREAK: Custom Hydrators API change
As of 2.5, `AbstractHydrator` does not enforce the usage of cache as part of
API, and now provides you a clean API for column information through the method
`hydrateColumnInfo($column)`.
Cache variable being passed around by reference is no longer needed since
Hydrators are per query instantiated since Doctrine 2.4.
## Minor BC BREAK: Entity based ``EntityManager#clear()`` calls follow cascade detach ## Minor BC BREAK: Entity based ``EntityManager#clear()`` calls follow cascade detach
Whenever ``EntityManager#clear()`` method gets called with a given entity class Whenever ``EntityManager#clear()`` method gets called with a given entity class

85
lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php
View file

@ -162,7 +162,7 @@ abstract class AbstractHydrator
$result = array(); $result = array();
$this->hydrateRowData($row, $this->_cache, $result); $this->hydrateRowData($row, $result);
return $result; return $result;
} }
@ -209,14 +209,13 @@ abstract class AbstractHydrator
* Template method. * Template method.
* *
* @param array $data The row data. * @param array $data The row data.
* @param array $cache The cache to use.
* @param array $result The result to fill. * @param array $result The result to fill.
* *
* @return void * @return void
* *
* @throws HydrationException * @throws HydrationException
*/ */
protected function hydrateRowData(array $data, array &$cache, array &$result) protected function hydrateRowData(array $data, array &$result)
{ {
throw new HydrationException("hydrateRowData() not implemented by this hydrator."); throw new HydrationException("hydrateRowData() not implemented by this hydrator.");
} }
@ -238,19 +237,18 @@ abstract class AbstractHydrator
* the values applied. Scalar values are kept in a specific key 'scalars'. * the values applied. Scalar values are kept in a specific key 'scalars'.
* *
* @param array $data SQL Result Row. * @param array $data SQL Result Row.
* @param array &$cache Cache for column to field result information.
* @param array &$id Dql-Alias => ID-Hash. * @param array &$id Dql-Alias => ID-Hash.
* @param array &$nonemptyComponents Does this DQL-Alias has at least one non NULL value? * @param array &$nonemptyComponents Does this DQL-Alias has at least one non NULL value?
* *
* @return array An array with all the fields (name => value) of the data row, * @return array An array with all the fields (name => value) of the data row,
* grouped by their component alias. * grouped by their component alias.
*/ */
protected function gatherRowData(array $data, array &$cache, array &$id, array &$nonemptyComponents) protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents)
{ {
$rowData = array('data' => array()); $rowData = array('data' => array());
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
$cacheKeyInfo = $this->getColumnCacheInfo($key, $cache); $cacheKeyInfo = $this->hydrateColumnInfo($key);
if ( ! $cacheKeyInfo) { if ( ! $cacheKeyInfo) {
continue; continue;
@ -332,16 +330,15 @@ abstract class AbstractHydrator
* of elements as before. * of elements as before.
* *
* @param array $data * @param array $data
* @param array $cache
* *
* @return array The processed row. * @return array The processed row.
*/ */
protected function gatherScalarRowData(&$data, &$cache) protected function gatherScalarRowData(&$data)
{ {
$rowData = array(); $rowData = array();
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
$cacheKeyInfo = $this->getColumnCacheInfo($key, $cache); $cacheKeyInfo = $this->hydrateColumnInfo($key);
if ( ! $cacheKeyInfo) { if ( ! $cacheKeyInfo) {
continue; continue;
@ -379,17 +376,16 @@ abstract class AbstractHydrator
} }
/** /**
* Retrieve column information from cache. * Retrieve column information from ResultSetMapping.
* *
* @param string $key Column name * @param string $key Column name
* @param array &$cache Cache for column to field result information.
* *
* @return array|null * @return array|null
*/ */
protected function getColumnCacheInfo($key, &$cache) protected function hydrateColumnInfo($key)
{ {
if (isset($cache[$key])) { if (isset($this->_cache[$key])) {
return $cache[$key]; return $this->_cache[$key];
} }
switch (true) { switch (true) {
@ -398,45 +394,50 @@ abstract class AbstractHydrator
$fieldName = $this->_rsm->fieldMappings[$key]; $fieldName = $this->_rsm->fieldMappings[$key];
$classMetadata = $this->_em->getClassMetadata($this->_rsm->declaringClasses[$key]); $classMetadata = $this->_em->getClassMetadata($this->_rsm->declaringClasses[$key]);
$cache[$key]['fieldName'] = $fieldName; return $this->_cache[$key] = array(
$cache[$key]['type'] = Type::getType($classMetadata->fieldMappings[$fieldName]['type']); 'isIdentifier' => $classMetadata->isIdentifier($fieldName),
$cache[$key]['isIdentifier'] = $classMetadata->isIdentifier($fieldName); 'fieldName' => $fieldName,
$cache[$key]['dqlAlias'] = $this->_rsm->columnOwnerMap[$key]; 'type' => Type::getType($classMetadata->fieldMappings[$fieldName]['type']),
'dqlAlias' => $this->_rsm->columnOwnerMap[$key],
return $cache[$key]; );
case (isset($this->_rsm->newObjectMappings[$key])): case (isset($this->_rsm->newObjectMappings[$key])):
// WARNING: A NEW object is also a scalar, so it must be declared before! // WARNING: A NEW object is also a scalar, so it must be declared before!
$mapping = $this->_rsm->newObjectMappings[$key]; $mapping = $this->_rsm->newObjectMappings[$key];
$cache[$key]['isScalar'] = true; return $this->_cache[$key] = array(
$cache[$key]['isNewObjectParameter'] = true; 'isScalar' => true,
$cache[$key]['fieldName'] = $this->_rsm->scalarMappings[$key]; 'isNewObjectParameter' => true,
$cache[$key]['type'] = Type::getType($this->_rsm->typeMappings[$key]); 'fieldName' => $this->_rsm->scalarMappings[$key],
$cache[$key]['argIndex'] = $mapping['argIndex']; 'type' => Type::getType($this->_rsm->typeMappings[$key]),
$cache[$key]['objIndex'] = $mapping['objIndex']; 'argIndex' => $mapping['argIndex'],
$cache[$key]['class'] = new \ReflectionClass($mapping['className']); 'objIndex' => $mapping['objIndex'],
'class' => new \ReflectionClass($mapping['className']),
return $cache[$key]; );
case (isset($this->_rsm->scalarMappings[$key])): case (isset($this->_rsm->scalarMappings[$key])):
$cache[$key]['fieldName'] = $this->_rsm->scalarMappings[$key]; return $this->_cache[$key] = array(
$cache[$key]['type'] = Type::getType($this->_rsm->typeMappings[$key]); 'isScalar' => true,
$cache[$key]['isScalar'] = true; 'fieldName' => $this->_rsm->scalarMappings[$key],
'type' => Type::getType($this->_rsm->typeMappings[$key]),
return $cache[$key]; );
case (isset($this->_rsm->metaMappings[$key])): case (isset($this->_rsm->metaMappings[$key])):
// Meta column (has meaning in relational schema only, i.e. foreign keys or discriminator columns). // Meta column (has meaning in relational schema only, i.e. foreign keys or discriminator columns).
$fieldName = $this->_rsm->metaMappings[$key]; $fieldName = $this->_rsm->metaMappings[$key];
$classMetadata = $this->_em->getClassMetadata($this->_rsm->aliasMap[$this->_rsm->columnOwnerMap[$key]]); $dqlAlias = $this->_rsm->columnOwnerMap[$key];
$classMetadata = $this->_em->getClassMetadata($this->_rsm->aliasMap[$dqlAlias]);
$type = isset($this->_rsm->typeMappings[$key])
? Type::getType($this->_rsm->typeMappings[$key])
: null;
$cache[$key]['isMetaColumn'] = true; return $this->_cache[$key] = array(
$cache[$key]['fieldName'] = $fieldName; 'isIdentifier' => isset($this->_rsm->isIdentifierColumn[$dqlAlias][$key]),
$cache[$key]['dqlAlias'] = $this->_rsm->columnOwnerMap[$key]; 'isMetaColumn' => true,
$cache[$key]['isIdentifier'] = isset($this->_rsm->isIdentifierColumn[$cache[$key]['dqlAlias']][$key]); 'fieldName' => $fieldName,
'type' => $type,
return $cache[$key]; 'dqlAlias' => $dqlAlias,
);
} }
// this column is a left over, maybe from a LIMIT query hack for example in Oracle or DB2 // this column is a left over, maybe from a LIMIT query hack for example in Oracle or DB2

7
lib/Doctrine/ORM/Internal/Hydration/ArrayHydrator.php
View file

@ -91,10 +91,9 @@ class ArrayHydrator extends AbstractHydrator
protected function hydrateAllData() protected function hydrateAllData()
{ {
$result = array(); $result = array();
$cache = array();
while ($data = $this->_stmt->fetch(PDO::FETCH_ASSOC)) { while ($data = $this->_stmt->fetch(PDO::FETCH_ASSOC)) {
$this->hydrateRowData($data, $cache, $result); $this->hydrateRowData($data, $result);
} }
return $result; return $result;
@ -103,12 +102,12 @@ class ArrayHydrator extends AbstractHydrator
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
protected function hydrateRowData(array $row, array &$cache, array &$result) protected function hydrateRowData(array $row, array &$result)
{ {
// 1) Initialize // 1) Initialize
$id = $this->_idTemplate; // initialize the id-memory $id = $this->_idTemplate; // initialize the id-memory
$nonemptyComponents = array(); $nonemptyComponents = array();
$rowData = $this->gatherRowData($row, $cache, $id, $nonemptyComponents); $rowData = $this->gatherRowData($row, $id, $nonemptyComponents);
// 2) Now hydrate the data found in the current row. // 2) Now hydrate the data found in the current row.
foreach ($rowData['data'] as $dqlAlias => $data) { foreach ($rowData['data'] as $dqlAlias => $data) {

8
lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php
View file

@ -173,10 +173,9 @@ class ObjectHydrator extends AbstractHydrator
protected function hydrateAllData() protected function hydrateAllData()
{ {
$result = array(); $result = array();
$cache = array();
while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) { while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) {
$this->hydrateRowData($row, $cache, $result); $this->hydrateRowData($row, $result);
} }
// Take snapshots from all newly initialized collections // Take snapshots from all newly initialized collections
@ -351,18 +350,17 @@ class ObjectHydrator extends AbstractHydrator
* specified by the FROM clause in a DQL query. * specified by the FROM clause in a DQL query.
* *
* @param array $row The data of the row to process. * @param array $row The data of the row to process.
* @param array $cache The cache to use.
* @param array $result The result array to fill. * @param array $result The result array to fill.
* *
* @return void * @return void
*/ */
protected function hydrateRowData(array $row, array &$cache, array &$result) protected function hydrateRowData(array $row, array &$result)
{ {
// Initialize // Initialize
$id = $this->idTemplate; // initialize the id-memory $id = $this->idTemplate; // initialize the id-memory
$nonemptyComponents = array(); $nonemptyComponents = array();
// Split the row data into chunks of class data. // Split the row data into chunks of class data.
$rowData = $this->gatherRowData($row, $cache, $id, $nonemptyComponents); $rowData = $this->gatherRowData($row, $id, $nonemptyComponents);
// Hydrate the data chunks // Hydrate the data chunks
foreach ($rowData['data'] as $dqlAlias => $data) { foreach ($rowData['data'] as $dqlAlias => $data) {

6
lib/Doctrine/ORM/Internal/Hydration/ScalarHydrator.php
View file

@ -39,7 +39,7 @@ class ScalarHydrator extends AbstractHydrator
$cache = array(); $cache = array();
while ($data = $this->_stmt->fetch(\PDO::FETCH_ASSOC)) { while ($data = $this->_stmt->fetch(\PDO::FETCH_ASSOC)) {
$this->hydrateRowData($data, $cache, $result); $this->hydrateRowData($data, $result);
} }
return $result; return $result;
@ -48,8 +48,8 @@ class ScalarHydrator extends AbstractHydrator
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
protected function hydrateRowData(array $data, array &$cache, array &$result) protected function hydrateRowData(array $data, array &$result)
{ {
$result[] = $this->gatherScalarRowData($data, $cache); $result[] = $this->gatherScalarRowData($data);
} }
} }

75
lib/Doctrine/ORM/Internal/Hydration/SimpleObjectHydrator.php
View file

@ -42,10 +42,9 @@ class SimpleObjectHydrator extends AbstractHydrator
protected function hydrateAllData() protected function hydrateAllData()
{ {
$result = array(); $result = array();
$cache = array();
while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) { while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) {
$this->hydrateRowData($row, $cache, $result); $this->hydrateRowData($row, $result);
} }
$this->_em->getUnitOfWork()->triggerEagerLoads(); $this->_em->getUnitOfWork()->triggerEagerLoads();
@ -81,7 +80,7 @@ class SimpleObjectHydrator extends AbstractHydrator
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
protected function hydrateRowData(array $sqlResult, array &$cache, array &$result) protected function hydrateRowData(array $sqlResult, array &$result)
{ {
$entityName = $this->class->name; $entityName = $this->class->name;
$data = array(); $data = array();
@ -103,30 +102,35 @@ class SimpleObjectHydrator extends AbstractHydrator
if ( ! isset($discrMap[$sqlResult[$discrColumnName]])) { if ( ! isset($discrMap[$sqlResult[$discrColumnName]])) {
throw HydrationException::invalidDiscriminatorValue($sqlResult[$discrColumnName], array_keys($discrMap)); throw HydrationException::invalidDiscriminatorValue($sqlResult[$discrColumnName], array_keys($discrMap));
} }
$entityName = $discrMap[$sqlResult[$discrColumnName]]; $entityName = $discrMap[$sqlResult[$discrColumnName]];
unset($sqlResult[$discrColumnName]); unset($sqlResult[$discrColumnName]);
} }
foreach ($sqlResult as $column => $value) { foreach ($sqlResult as $column => $value) {
// Hydrate column information if not yet present // An ObjectHydrator should be used instead of SimpleObjectHydrator
if ( ! isset($cache[$column])) { if (isset($this->_rsm->relationMap[$column])) {
if (($info = $this->hydrateColumnInfo($entityName, $column)) === null) { throw new \Exception(sprintf('Unable to retrieve association information for column "%s"', $column));
continue; }
}
$cache[$column] = $info; $cacheKeyInfo = $this->hydrateColumnInfo($column);
if ( ! $cacheKeyInfo) {
continue;
} }
// Convert field to a valid PHP value // Convert field to a valid PHP value
if (isset($cache[$column]['type'])) { if (isset($cacheKeyInfo['type'])) {
$value = Type::getType($cache[$column]['type'])->convertToPHPValue($value, $this->_platform); $type = $cacheKeyInfo['type'];
$value = $type->convertToPHPValue($value, $this->_platform);
} }
$fieldName = $cacheKeyInfo['fieldName'];
// Prevent overwrite in case of inherit classes using same property name (See AbstractHydrator) // Prevent overwrite in case of inherit classes using same property name (See AbstractHydrator)
if (isset($cache[$column]) && ( ! isset($data[$cache[$column]['name']]) || $value !== null)) { if ( ! isset($data[$fieldName]) || $value !== null) {
$data[$cache[$column]['name']] = $value; $data[$fieldName] = $value;
} }
} }
@ -139,47 +143,4 @@ class SimpleObjectHydrator extends AbstractHydrator
$result[] = $entity; $result[] = $entity;
} }
/**
* Retrieve column information form ResultSetMapping.
*
* @param string $entityName
* @param string $column
*
* @return array
*/
protected function hydrateColumnInfo($entityName, $column)
{
if (isset($this->_rsm->fieldMappings[$column])) {
$name = $this->_rsm->fieldMappings[$column];
$class = isset($this->declaringClasses[$column])
? $this->declaringClasses[$column]
: $this->class;
// If class is not part of the inheritance, ignore
if ( ! ($class->name === $entityName || is_subclass_of($entityName, $class->name))) {
return null;
}
return array(
'name' => $name,
'type' => $class->fieldMappings[$name]['type']
);
}
if (isset($this->_rsm->metaMappings[$column])) {
return array(
'name' => $this->_rsm->metaMappings[$column],
'type' => (isset($this->_rsm->typeMappings[$column]) ? $this->_rsm->typeMappings[$column] : null)
);
}
// An ObjectHydrator should be used instead of SimpleObjectHydrator
if (isset($this->_rsm->relationMap[$column])) {
throw new \Exception(sprintf('Unable to retrieve association information for column "%s"', $column));
}
return null;
}
} }