2 /***************************************************************
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
29 * A persistence backend. This backend maps objects to the relational model of the storage backend.
30 * It persists all added, removed and changed objects.
33 * @subpackage Persistence
34 * @version $Id: Backend.php 2183 2009-04-24 14:28:37Z k-fish $
36 class Tx_Extbase_Persistence_Backend
implements Tx_Extbase_Persistence_BackendInterface
, t3lib_Singleton
{
39 * @var Tx_Extbase_Persistence_Session
44 * @var Tx_Extbase_Persistence_ObjectStorage
46 protected $aggregateRootObjects;
49 * @var Tx_Extbase_Persistence_IdentityMap
51 protected $identityMap;
54 * @var Tx_Extbase_Persistence_QueryFactoryInterface
56 protected $queryFactory;
59 * @var Tx_Extbase_Persistence_QOM_QueryObjectModelFactoryInterface
61 protected $QOMFactory;
64 * @var Tx_Extbase_Persistence_ValueFactoryInterface
66 protected $valueFactory;
69 * @var Tx_Extbase_Persistence_Storage_BackendInterface
71 protected $storageBackend;
74 * @var Tx_Extbase_Persistence_DataMapper
76 protected $dataMapper;
79 * The TYPO3 reference index object
83 protected $referenceIndex;
86 * Constructs the backend
88 * @param Tx_Extbase_Persistence_Session $session The persistence session used to persist data
90 public function __construct(Tx_Extbase_Persistence_Session
$session, Tx_Extbase_Persistence_Storage_BackendInterface
$storageBackend) {
91 $this->session
= $session;
92 $this->storageBackend
= $storageBackend;
93 $this->referenceIndex
= t3lib_div
::makeInstance('t3lib_refindex');
94 $this->aggregateRootObjects
= new Tx_Extbase_Persistence_ObjectStorage();
98 * Injects the DataMapper to map nodes to objects
100 * @param Tx_Extbase_Persistence_Mapper_DataMapper $dataMapper
103 public function injectDataMapper(Tx_Extbase_Persistence_Mapper_DataMapper
$dataMapper) {
104 $this->dataMapper
= $dataMapper;
108 * Injects the identity map
110 * @param Tx_Extbase_Persistence_IdentityMap $identityMap
113 public function injectIdentityMap(Tx_Extbase_Persistence_IdentityMap
$identityMap) {
114 $this->identityMap
= $identityMap;
118 * Injects the QueryFactory
120 * @param Tx_Extbase_Persistence_QueryFactoryInterface $queryFactory
123 public function injectQueryFactory(Tx_Extbase_Persistence_QueryFactoryInterface
$queryFactory) {
124 $this->queryFactory
= $queryFactory;
128 * Injects the QueryObjectModelFactory
130 * @param Tx_Extbase_Persistence_QOM_QueryObjectModelFactoryInterface $dataMapper
133 public function injectQOMFactory(Tx_Extbase_Persistence_QOM_QueryObjectModelFactoryInterface
$QOMFactory) {
134 $this->QOMFactory
= $QOMFactory;
138 * Injects the ValueFactory
140 * @param Tx_Extbase_Persistence_ValueFactoryInterface $valueFactory
143 public function injectValueFactory(Tx_Extbase_Persistence_ValueFactoryInterface
$valueFactory) {
144 $this->valueFactory
= $valueFactory;
148 * Returns the repository session
150 * @return Tx_Extbase_Persistence_Session
152 public function getSession() {
153 return $this->session
;
157 * Returns the Data Mapper
159 * @return Tx_Extbase_Persistence_Mapper_DataMapper
161 public function getDataMapper() {
162 return $this->dataMapper
;
166 * Returns the current QOM factory
168 * @return Tx_Extbase_Persistence_QOM_QueryObjectModelFactoryInterface
170 public function getQOMFactory() {
171 return $this->QOMFactory
;
175 * Returns the current value factory
177 * @return Tx_Extbase_Persistence_ValueFactoryInterface
179 public function getValueFactory() {
180 return $this->valueFactory
;
184 * Returns the current identityMap
186 * @return Tx_Extbase_Persistence_IdentityMap
188 public function getIdentityMap() {
189 return $this->identityMap
;
193 * Returns the (internal) identifier for the object, if it is known to the
194 * backend. Otherwise NULL is returned.
196 * @param object $object
197 * @return string The identifier for the object if it is known, or NULL
199 public function getIdentifierByObject($object) {
200 if ($this->identityMap
->hasObject($object)) {
201 return $this->identityMap
->getIdentifierByObject($object);
208 * Returns the object with the (internal) identifier, if it is known to the
209 * backend. Otherwise NULL is returned.
211 * @param string $identifier
212 * @param string $className
213 * @return object The object for the identifier if it is known, or NULL
215 public function getObjectByIdentifier($identifier, $className) {
216 if ($this->identityMap
->hasIdentifier($identifier, $className)) {
217 return $this->identityMap
->getObjectByIdentifier($identifier, $className);
219 $query = $this->queryFactory
->create($className);
220 $result = $query->matching($query->withUid($uid))->execute();
222 if (count($result) > 0) {
223 $object = current($result);
230 * Checks if the given object has ever been persisted.
232 * @param object $object The object to check
233 * @return boolean TRUE if the object is new, FALSE if the object exists in the repository
235 public function isNewObject($object) {
236 return ($this->getIdentifierByObject($object) === NULL);
240 * Replaces the given object by the second object.
242 * This method will unregister the existing object at the identity map and
243 * register the new object instead. The existing object must therefore
244 * already be registered at the identity map which is the case for all
245 * reconstituted objects.
247 * The new object will be identified by the uid which formerly belonged
248 * to the existing object. The existing object looses its uid.
250 * @param object $existingObject The existing object
251 * @param object $newObject The new object
254 public function replaceObject($existingObject, $newObject) {
255 $existingUid = $this->getIdentifierByObject($existingObject);
256 if ($existingUid === NULL) throw new Tx_Extbase_Persistence_Exception_UnknownObject('The given object is unknown to this persistence backend.', 1238070163);
258 $this->identityMap
->unregisterObject($existingObject);
259 $this->identityMap
->registerObject($newObject, $existingUid);
263 * Sets the aggregate root objects
265 * @param Tx_Extbase_Persistence_ObjectStorage $objects
268 public function setAggregateRootObjects(Tx_Extbase_Persistence_ObjectStorage
$objects) {
269 $this->aggregateRootObjects
= $objects;
273 * Sets the deleted objects
275 * @param Tx_Extbase_Persistence_ObjectStorage $objects
278 public function setDeletedObjects(Tx_Extbase_Persistence_ObjectStorage
$objects) {
279 $this->deletedObjects
= $objects;
283 * Commits the current persistence session.
287 public function commit() {
288 $this->persistObjects();
289 $this->processDeletedObjects();
293 * Traverse and persist all aggregate roots and their object graph.
297 protected function persistObjects() {
298 foreach ($this->aggregateRootObjects
as $object) {
299 $this->persistObject($object);
304 * Persists an object (instert, update) and its related objects (instert, update, delete).
306 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to be inserted
307 * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject The parent object
308 * @param string $parentPropertyName The name of the property the object is stored in
311 protected function persistObject(Tx_Extbase_DomainObject_DomainObjectInterface
$object, $parentObject = NULL, $parentPropertyName = NULL) {
313 $queuedObjects = array();
314 $className = get_class($object);
315 $dataMap = $this->dataMapper
->getDataMap($className);
317 if ($object instanceof Tx_Extbase_DomainObject_AbstractValueObject
) {
318 $this->mapAlreadyPersistedValueObject($object);
321 $properties = $object->_getProperties();
322 // Fill up $row[$columnName] array with changed values which need to be stored
323 foreach ($properties as $propertyName => $propertyValue) {
324 if (!$dataMap->isPersistableProperty($propertyName) ||
($propertyValue instanceof Tx_Extbase_Persistence_LazyLoadingProxy
)) {
328 $columnMap = $dataMap->getColumnMap($propertyName);
329 if ($object->_isNew() ||
$object->_isDirty($propertyName)) {
330 if ($columnMap->isRelation()) {
331 $this->persistRelations($object, $propertyName, $propertyValue, $columnMap, $queuedObjects, $row);
333 // We have not a relation, this means it is a scalar (like a string or interger value) or an object
334 $row[$columnMap->getColumnName()] = $dataMap->convertPropertyValueToFieldValue($propertyValue);
337 } // end property iteration for loop
339 // The state of the Object has to be stored in a local variable because $object->_isNew() will return FALSE after
340 // the object was inserted. We need the initial state here.
341 $objectIsNew = $object->_isNew();
342 if ($objectIsNew === TRUE) {
343 $this->insertObject($object, $parentObject, $parentPropertyName, $row);
344 } elseif ($object->_isDirty()) {
345 $this->updateObject($object, $parentObject, $parentPropertyName, $row);
348 $objectHasToBeUpdated = $this->processQueuedChildObjects($object, $queuedObjects, $row);
349 if ($objectHasToBeUpdated === TRUE) {
350 // TODO Check if this can be merged with the first update
351 $this->updateObject($object, $parentObject, $parentPropertyName, $row);
354 // SK: I need to check the code below more thoroughly
355 if ($parentObject instanceof Tx_Extbase_DomainObject_DomainObjectInterface
&& !empty($parentPropertyName)) {
356 $parentDataMap = $this->dataMapper
->getDataMap(get_class($parentObject));
357 $parentColumnMap = $parentDataMap->getColumnMap($parentPropertyName);
358 if (($parentColumnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_AND_BELONGS_TO_MANY
)) {
359 $this->insertRelationInRelationtable($object, $parentObject, $parentPropertyName);
363 $this->identityMap
->registerObject($object, $object->getUid());
364 $object->_memorizeCleanState();
368 * Persists a relation. Objects of a 1:n or m:n relation are queued and processed with the parent object. A 1:1 relation
369 * gets persisted immediately. Objects which were removed from the property were deleted immediately, too.
371 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to be inserted
372 * @param string $propertyName The name of the property the related objects are stored in
373 * @param mixed $propertyValue The property value (an array of Domain Objects, ObjectStorage holding Domain Objects or a Domain Object itself)
376 protected function persistRelations(Tx_Extbase_DomainObject_DomainObjectInterface
$object, $propertyName, $propertyValue, Tx_Extbase_Persistence_Mapper_ColumnMap
$columnMap, &$queuedObjects, &$row) {
377 $columnName = $columnMap->getColumnName();
378 if (($columnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_MANY
) ||
($columnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_AND_BELONGS_TO_MANY
)) {
379 if (is_array($propertyValue) ||
$propertyValue instanceof ArrayAccess
) {
380 foreach ($propertyValue as $relatedObject) {
381 $queuedObjects[$propertyName][] = $relatedObject;
383 foreach ($this->getDeletedChildObjects($object, $propertyName) as $deletedObject) {
384 $this->deleteObject($deletedObject, $object, $propertyName, TRUE, FALSE);
386 $row[$columnName] = count($propertyValue); // Will be overwritten if the related objects are referenced by a comma separated list
388 } elseif ($propertyValue instanceof Tx_Extbase_DomainObject_DomainObjectInterface
) {
389 // TODO Handle Value Objects different
390 if ($propertyValue->_isNew() ||
$propertyValue->_isDirty()) {
391 $this->persistObject($propertyValue);
393 $row[$columnName] = $propertyValue->getUid();
398 * Returns the deleted objects determined by a comparison of the clean property value
399 * with the actual property value.
401 * @param Tx_Extbase_DomainObject_AbstractEntity $object The object to be insterted in the storage
402 * @param string $parentPropertyName The name of the property
403 * @return array An array of deleted objects
405 protected function getDeletedChildObjects(Tx_Extbase_DomainObject_AbstractEntity
$object, $propertyName) {
406 $deletedObjects = array();
407 if (!$object->_isNew()) {
408 $cleanProperties = $object->_getCleanProperties();
409 $cleanPropertyValue = $cleanProperties[$propertyName];
410 $propertyValue = $object->_getProperty($propertyName);
411 if ($cleanPropertyValue instanceof Tx_Extbase_Persistence_ObjectStorage
) {
412 $cleanPropertyValue = $cleanPropertyValue->toArray();
414 if ($propertyValue instanceof Tx_Extbase_Persistence_ObjectStorage
) {
415 $propertyValue = $propertyValue->toArray();
417 $deletedObjects = array_diff($cleanPropertyValue, $propertyValue);
420 return $deletedObjects;
424 * This function processes the queued child objects to be persisted. The queue is build while looping over the
425 * collection of Domain Objects stored in a object property.
427 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object holding the collection
428 * @param array $queuedObjects The queued child objects
429 * @param array $row The row to be inseted or updated in the database. Passed as reference.
430 * @return boolean TRUE if the object holding the collection has to be updated; otherwise FALSE
432 protected function processQueuedChildObjects(Tx_Extbase_DomainObject_DomainObjectInterface
$object, array $queuedChildObjects, array &$row) {
433 $objectHasToBeUpdated = FALSE;
434 $className = get_class($object);
435 $dataMap = $this->dataMapper
->getDataMap($className);
436 foreach ($queuedChildObjects as $propertyName => $childObjects) {
437 $columnMap = $dataMap->getColumnMap($propertyName);
438 $childPidArray = array();
439 foreach($childObjects as $childObject) {
440 $this->persistObject($childObject, $object, $propertyName);
441 if ($childObject instanceof Tx_Extbase_DomainObject_DomainObjectInterface
) {
442 $childPidArray[] = (int)$childObject->getUid();
445 if ($columnMap->getParentKeyFieldName() === NULL) { // TRUE: We have to generate a comma separated list stored in the field
446 if (count($childPidArray) > 0) {
447 $row[$propertyName] = implode(',', $childPidArray);
449 $row[$propertyName] = NULL;
451 $objectHasToBeUpdated = TRUE;
454 return $objectHasToBeUpdated;
458 * Tests, if the given Value Object already exists in the storage backend. If so, it maps the uid
459 * to the given object.
461 * @param Tx_Extbase_DomainObject_AbstractValueObject $object The object to be tested
463 protected function mapAlreadyPersistedValueObject(Tx_Extbase_DomainObject_AbstractValueObject
$object) {
464 $dataMap = $this->dataMapper
->getDataMap(get_class($object));
465 $properties = $object->_getProperties();
466 $result = $this->storageBackend
->hasValueObject($properties, $dataMap);
467 if ($result !== FALSE) {
468 $object->_setProperty('uid', $result);
473 * Inserts an object in the storage
475 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to be insterted in the storage
476 * @param Tx_Extbase_DomainObject_AbstractEntity|NULL $parentObject The parent object (if any)
477 * @param string|NULL $parentPropertyName The name of the property
478 * @param array $row The $row
480 protected function insertObject(Tx_Extbase_DomainObject_DomainObjectInterface
$object, Tx_Extbase_DomainObject_AbstractEntity
$parentObject = NULL, $parentPropertyName = NULL, array &$row) {
481 $className = get_class($object);
482 $dataMap = $this->dataMapper
->getDataMap($className);
483 $tableName = $dataMap->getTableName();
484 $this->addCommonFieldsToRow($object, $parentObject, $parentPropertyName, $row);
485 $uid = $this->storageBackend
->addRow(
489 $object->_setProperty('uid', $uid);
490 $this->referenceIndex
->updateRefIndexTable($tableName, $uid);
494 * Inserts mm-relation into a relation table
496 * @param Tx_Extbase_DomainObject_DomainObjectInterface $relatedObject The related object
497 * @param Tx_Extbase_DomainObject_DomainObjectInterface $parentObject The parent object
498 * @param string $parentPropertyName The name of the parent object's property where the related objects are stored in
501 protected function insertRelationInRelationtable(Tx_Extbase_DomainObject_DomainObjectInterface
$relatedObject, Tx_Extbase_DomainObject_DomainObjectInterface
$parentObject, $parentPropertyName) {
502 $dataMap = $this->dataMapper
->getDataMap(get_class($parentObject));
503 $columnMap = $dataMap->getColumnMap($parentPropertyName);
505 $columnMap->getParentKeyFieldName() => (int)$parentObject->getUid(),
506 $columnMap->getChildKeyFieldName() => (int)$relatedObject->getUid(),
507 'tablenames' => $columnMap->getChildTableName(),
508 'sorting' => 9999 // TODO sorting of mm table items
510 $res = $this->storageBackend
->addRow(
511 $columnMap->getRelationTableName(),
518 * Updates a given object in the storage
520 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to be insterted in the storage
521 * @param Tx_Extbase_DomainObject_AbstractEntity|NULL $parentObject The parent object (if any)
522 * @param string|NULL $parentPropertyName The name of the property
523 * @param array $row The $row
525 protected function updateObject(Tx_Extbase_DomainObject_DomainObjectInterface
$object, $parentObject = NULL, $parentPropertyName = NULL, array &$row) {
526 $className = get_class($object);
527 $dataMap = $this->dataMapper
->getDataMap($className);
528 $tableName = $dataMap->getTableName();
529 $this->addCommonFieldsToRow($object, $parentObject, $parentPropertyName, $row);
530 $uid = $object->getUid();
532 $res = $this->storageBackend
->updateRow(
536 $this->referenceIndex
->updateRefIndexTable($tableName, $uid);
541 * Returns a table row to be inserted or updated in the database
543 * @param Tx_Extbase_Persistence_Mapper_DataMap $dataMap The appropriate data map representing a database table
544 * @param array $properties The properties of the object
545 * @return array A single row to be inserted in the database
547 protected function addCommonFieldsToRow(Tx_Extbase_DomainObject_DomainObjectInterface
$object, $parentObject = NULL, $parentPropertyName = NULL, array &$row) {
548 $className = get_class($object);
549 $dataMap = $this->dataMapper
->getDataMap($className);
550 if ($dataMap->hasCreationDateColumn() && $object->_isNew()) {
551 $row[$dataMap->getCreationDateColumnName()] = $GLOBALS['EXEC_TIME'];
553 if ($dataMap->hasTimestampColumn()) {
554 $row[$dataMap->getTimestampColumnName()] = $GLOBALS['EXEC_TIME'];
557 if ($object->_isNew() && $dataMap->hasPidColumn() && !isset($row['pid'])) {
558 $row['pid'] = $this->determineStoragePageIdForNewRecord($object);
561 if ($parentObject instanceof Tx_Extbase_DomainObject_DomainObjectInterface
&& !empty($parentPropertyName)) {
562 $parentDataMap = $this->dataMapper
->getDataMap(get_class($parentObject));
563 $parentColumnMap = $parentDataMap->getColumnMap($parentPropertyName);
564 // FIXME This is a hacky solution
565 if ($parentColumnMap->getTypeOfRelation() !== Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_AND_BELONGS_TO_MANY
) {
566 $parentKeyFieldName = $parentColumnMap->getParentKeyFieldName();
567 if ($parentKeyFieldName !== NULL) {
568 $row[$parentKeyFieldName] = $parentObject->getUid();
570 $parentTableFieldName = $parentColumnMap->getParentTableFieldName();
571 if ($parentTableFieldName !== NULL) {
572 $row[$parentTableFieldName] = $parentDataMap->getTableName();
579 * Determine the storage page ID for a given NEW record
581 * This does the following:
582 * - If there is a TypoScript configuration "classes.CLASSNAME.newRecordStoragePid", that is used to store new records.
583 * - If there is no such TypoScript configuration, it uses the first value of The "storagePid" taken for reading records.
585 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object
586 * @return int the storage Page ID where the object should be stored
588 protected function determineStoragePageIdForNewRecord(Tx_Extbase_DomainObject_DomainObjectInterface
$object) {
589 $className = get_class($object);
590 $extbaseSettings = Tx_Extbase_Dispatcher
::getExtbaseFrameworkConfiguration();
592 if (isset($extbaseSettings['persistence']['classes'][$className]) && !empty($extbaseSettings['persistence']['classes'][$className]['newRecordStoragePid'])) {
593 return (int)$extbaseSettings['persistence']['classes'][$className]['newRecordStoragePid'];
595 $storagePidList = t3lib_div
::intExplode(',', $extbaseSettings['persistence']['storagePid']);
596 return (int) $storagePidList[0];
601 * Iterate over deleted aggregate root objects and process them
605 protected function processDeletedObjects() {
606 foreach ($this->deletedObjects
as $object) {
607 $this->deleteObject($object);
608 $this->identityMap
->unregisterObject($object);
610 $this->deletedObjects
= new Tx_Extbase_Persistence_ObjectStorage();
614 * Deletes an object, it's 1:n related objects, and the m:n relations in relation tables (but not the m:n related objects!)
616 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to be insterted in the storage
617 * @param Tx_Extbase_DomainObject_AbstractEntity|NULL $parentObject The parent object (if any)
618 * @param string|NULL $parentPropertyName The name of the property
619 * @param bool $markAsDeleted Shold we only mark the row as deleted instead of deleting (TRUE by default)?
622 protected function deleteObject(Tx_Extbase_DomainObject_DomainObjectInterface
$object, $parentObject = NULL, $parentPropertyName = NULL, $markAsDeleted = TRUE) {
623 // TODO Implement recursive deletions
624 $dataMap = $this->dataMapper
->getDataMap(get_class($object));
625 $tableName = $dataMap->getTableName();
626 if (($markAsDeleted === TRUE) && $dataMap->hasDeletedColumn()) {
627 $deletedColumnName = $dataMap->getDeletedColumnName();
628 $res = $this->storageBackend
->updateRow(
631 'uid' => $object->getUid(),
632 $deletedColumnName => 1
636 $res = $this->storageBackend
->removeRow(
641 $this->referenceIndex
->updateRefIndexTable($tableName, $uid);
645 * Delegates the call to the Data Map.
646 * Returns TRUE if the property is persistable (configured in $TCA)
648 * @param string $className The property name
649 * @param string $propertyName The property name
650 * @return boolean TRUE if the property is persistable (configured in $TCA)
652 public function isPersistableProperty($className, $propertyName) {
653 $dataMap = $this->dataMapper
->getDataMap($className);
654 return $dataMap->isPersistableProperty($propertyName);