secret
Last active

A hydrator for caching Objects at the sql result level, will add them to identity map on cache hit! Workaround for http://www.doctrine-project.org/jira/browse/DDC-217

  • Download Gist
CachedObjectHydrator.php
PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
<?php
 
namespace Whitewashing\Doctrine;
 
use Doctrine\ORM\Internal\Hydration\ObjectHydrator;
 
/** Reeally nasty hack to get cashing on the DBAL/PDO Statement level working. Dont do this at home :) */
class CachedObjectHydrator extends ObjectHydrator
{
public function closeCursor() {}
 
protected function _hydrateAll()
{
$result = array();
$cache = array();
 
$resultCache = $this->_em->getConfiguration()->getResultCacheImpl();
 
$cacheKey = false;
if ($resultCache && isset($this->_hints['whitewashing.object_cache_key'])) {
$cacheKey = $this->_hints['whitewashing.object_cache_key'];
}
 
if ($cacheKey && $rows = $resultCache->fetch($cacheKey)) {
foreach ($rows AS $row) {
$this->_hydrateRow($row, $cache, $result);
}
} else {
$rows = array();
while ($row = $this->_stmt->fetch(PDO::FETCH_ASSOC)) {
$this->_hydrateRow($row, $cache, $result);
if ($cacheKey) {
$rows[] = $row;
}
}
 
if ($cacheKey) {
$resultCache->save($cacheKey, $rows);
}
}
 
// This is not the hack you are looking for.
$reflObject = new \ReflectionClass("Doctrine\ORM\Internal\Hydration\ObjectHydrator");
$reflProp = $reflObject->getProperty("_initializedCollections");
$reflProp->setAccessible(true);
$cols = $reflProp->getValue($this);
 
// Take snapshots from all newly initialized collections
foreach ($cols as $coll) {
$coll->takeSnapshot();
}
 
return $result;
}
 
public function executeQuery($query)
{
// another hack nobody has seen!
$sql = $query->getSQL();
$reflObject = new \ReflectionClass("Doctrine\ORM\Query");
$reflProp = $reflObject->getProperty("_parserResult");
$reflProp->setAccessible(true);
$parserResult = $reflProp->getValue($query);
 
$rsm = $parserResult->getResultSetMapping();
 
$resultCache = $this->_em->getConfiguration()->getResultCacheImpl();
$hints = $query->getHints();
 
if ($resultCache && isset($hints['whitewashing.object_cache_key']) && $resultCache->contains($hints['whitewashing.object_cache_key'])) {
$stmt = $this;
} else {
$executor = $parserResult->getSqlExecutor();
 
// Prepare parameters
$paramMappings = $parserResult->getParameterMappings();
$params = $query->getParameters();
 
$reflObject = new \ReflectionClass("Doctrine\ORM\AbstractQuery");
$reflProp = $reflObject->getProperty("_types");
$reflProp->setAccessible(true);
$types = $reflProp->getValue($query);
 
if (count($paramMappings) != count($params)) {
throw \Doctrine\ORM\QueryException::invalidParameterNumber();
}
 
list($sqlParams, $types) = $this->processParameterMappings($paramMappings, $params, $types);
 
$stmt = $executor->execute($this->_em->getConnection(), $sqlParams, $types);
}
 
return $this->hydrateAll($stmt, $rsm, $hints);
}
 
/**
* Processes query parameter mappings
*
* @param array $paramMappings
* @return array
*/
private function processParameterMappings($paramMappings, $params, $types)
{
$sqlParams = $types = array();
foreach ($params as $key => $value) {
if ( ! isset($paramMappings[$key])) {
throw QueryException::unknownParameter($key);
}
if (isset($types[$key])) {
foreach ($paramMappings[$key] as $position) {
$types[$position] = $this->_paramTypes[$key];
}
}
$sqlPositions = $paramMappings[$key];
$value = array_values($this->processParameterValue($value));
$countValue = count($value);
for ($i = 0, $l = count($sqlPositions); $i < $l; $i++) {
$sqlParams[$sqlPositions[$i]] = $value[($i % $countValue)];
}
}
if ($sqlParams) {
ksort($sqlParams);
$sqlParams = array_values($sqlParams);
}
 
return array($sqlParams, $types);
}
 
private function processParameterValue($value)
{
switch (true) {
case is_array($value):
for ($i = 0, $l = count($value); $i < $l; $i++) {
$paramValue = $this->processParameterValue($value[$i]);
 
// TODO: What about Entities that have composite primary key?
$value[$i] = is_array($paramValue) ? $paramValue[key($paramValue)] : $paramValue;
}
 
return array($value);
case is_object($value) && $this->_em->getMetadataFactory()->hasMetadataFor(get_class($value)):
if ($this->_em->getUnitOfWork()->getEntityState($value) === UnitOfWork::STATE_MANAGED) {
return array_values($this->_em->getUnitOfWork()->getEntityIdentifier($value));
}
 
$class = $this->_em->getClassMetadata(get_class($value));
 
return array_values($class->getIdentifierValues($value));
default:
return array($value);
}
}
}
config.yml
YAML
1 2 3 4 5 6
# For Symfony integration
doctrine:
orm:
default:
hydrators:
cache_object: Vendor\Namespace\To\CachedObjectHydrator
example_code.php
PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
<?php
use Doctrine\ORM\Tools\Setup;
use Doctrine\ORM\EntityManager;
 
require_once "common.php";
 
 
/**
* @Entity
*/
class TestObject
{
/** @Id @GeneratedValue @Column(type="integer") */
public $id;
}
 
$paths = array(__DIR__ . "/lib", __DIR__ . "/lib/Foo");
$isDevMode = true;
 
$cache = new \Doctrine\Common\Cache\ArrayCache();
$config = Setup::createAnnotationMetadataConfiguration($paths, $isDevMode);
$config->addCustomHydrationMode('cache_object', 'CachedObjectHydrator');
$config->setResultCacheImpl($cache);
 
$em = EntityManager::create($dbParams, $config);
$st = new \Doctrine\ORM\Tools\SchemaTool($em);
$st->createSchema(array($em->getClassMetadata('TestObject')));
 
$to = new TestObject();
$em->persist($to);
$em->flush();
$em->clear();
 
$query = $em->createQuery("SELECT t FROM TestObject t");
$query->setHint('whitewashing.object_cache_key', 'test_obj1');
$hydrator = $em->newHydrator("cache_object");
$obj = $hydrator->executeQuery($query);
 
$em->clear();
 
$query = $em->createQuery("SELECT t FROM TestObject t");
$query->setHint('whitewashing.object_cache_key', 'test_obj1');
$hydrator = $em->newHydrator("cache_object");
$obj = $hydrator->executeQuery($query);
 
var_dump($em->contains($obj[0])); // returns true, its in the identity map, yay!

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.