2 /***************************************************************
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
26 * A mapper to map database tables configured in $TCA on domain objects.
29 * @subpackage Persistence\Mapper
32 class Tx_Extbase_Persistence_Mapper_DataMapper
implements t3lib_Singleton
{
35 * @var Tx_Extbase_Persistence_IdentityMap
37 protected $identityMap;
40 * @var Tx_Extbase_Reflection_Service
42 protected $reflectionService;
45 * @var Tx_Extbase_Persistence_QOM_QueryObjectModelFactory
47 protected $QOMFactory;
50 * @var Tx_Extbase_Persistence_Session
52 protected $persistenceSession;
55 * A reference to the page select object providing methods to perform language and work space overlays
57 * @var t3lib_pageSelect
59 protected $pageSelectObject;
66 protected $dataMaps = array();
69 * @var Tx_Extbase_Persistence_QueryFactoryInterface
71 protected $queryFactory;
74 * The TYPO3 reference index object
78 protected $referenceIndex;
81 * Constructs a new mapper
84 public function __construct() {
85 $this->queryFactory
= t3lib_div
::makeInstance('Tx_Extbase_Persistence_QueryFactory');
89 * Injects the identity map
91 * @param Tx_Extbase_Persistence_IdentityMap $identityMap
94 public function injectIdentityMap(Tx_Extbase_Persistence_IdentityMap
$identityMap) {
95 $this->identityMap
= $identityMap;
99 * Injects the persistence manager
101 * @param Tx_Extbase_Persistence_ManagerInterface $persistenceManager
104 public function injectPersistenceManager(Tx_Extbase_Persistence_ManagerInterface
$persistenceManager) {
105 $this->QOMFactory
= $persistenceManager->getBackend()->getQOMFactory();
106 $this->persistenceSession
= $persistenceManager->getSession();
110 * Injects the Reflection Service
112 * @param Tx_Extbase_Reflection_Service
115 public function injectReflectionService(Tx_Extbase_Reflection_Service
$reflectionService) {
116 $this->reflectionService
= $reflectionService;
120 * Maps the (aggregate root) rows and registers them as reconstituted
123 * @param Tx_Extbase_Persistence_RowIteratorInterface $rows
126 public function map($className, Tx_Extbase_Persistence_RowIteratorInterface
$rows) {
128 foreach ($rows as $row) {
129 $objects[] = $this->mapSingleRow($className, $row);
135 * Maps a single node into the object it represents
137 * @param Tx_Extbase_Persistence_RowInterface $node
140 protected function mapSingleRow($className, Tx_Extbase_Persistence_RowInterface
$row) {
141 if ($this->identityMap
->hasIdentifier($row->getValue('uid'), $className)) {
142 $object = $this->identityMap
->getObjectByIdentifier($row->getValue('uid'), $className);
144 $object = $this->createEmptyObject($className);
145 $this->thawProperties($object, $row);
146 $this->identityMap
->registerObject($object, $object->getUid());
147 $object->_memorizeCleanState();
148 $this->persistenceSession
->registerReconstitutedObject($object);
154 * Creates a skeleton of the specified object
156 * @param string $className Name of the class to create a skeleton for
157 * @return object The object skeleton
159 protected function createEmptyObject($className) {
160 // Note: The class_implements() function also invokes autoload to assure that the interfaces
161 // and the class are loaded. Would end up with __PHP_Incomplete_Class without it.
162 if (!in_array('Tx_Extbase_DomainObject_DomainObjectInterface', class_implements($className))) throw new Tx_Extbase_Object_Exception_CannotReconstituteObject('Cannot create empty instance of the class "' . $className . '" because it does not implement the Tx_Extbase_DomainObject_DomainObjectInterface.', 1234386924);
163 $object = unserialize('O:' . strlen($className) . ':"' . $className . '":0:{};');
168 * Sets the given properties on the object.
170 * @param Tx_Extbase_DomainObject_DomainObjectInterface $object The object to set properties on
171 * @param Tx_Extbase_Persistence_RowInterface $row
174 protected function thawProperties(Tx_Extbase_DomainObject_DomainObjectInterface
$object, Tx_Extbase_Persistence_RowInterface
$row) {
175 $className = get_class($object);
176 $dataMap = $this->getDataMap($className);
177 $properties = $object->_getProperties();
178 $object->_setProperty('uid', $row->getValue('uid'));
179 foreach ($properties as $propertyName => $propertyValue) {
180 if (!$dataMap->isPersistableProperty($propertyName)) continue;
181 $columnMap = $dataMap->getColumnMap($propertyName);
182 $columnName = $columnMap->getColumnName();
183 $propertyValue = NULL;
184 $propertyType = $columnMap->getPropertyType();
185 switch ($propertyType) {
186 case Tx_Extbase_Persistence_PropertyType
::STRING;
187 case Tx_Extbase_Persistence_PropertyType
::DATE
;
188 case Tx_Extbase_Persistence_PropertyType
::LONG
;
189 case Tx_Extbase_Persistence_PropertyType
::DOUBLE;
190 case Tx_Extbase_Persistence_PropertyType
::BOOLEAN
;
191 if ($row->hasValue($columnName)) {
192 $rawPropertyValue = $row->getValue($columnName);
193 $propertyValue = $dataMap->convertFieldValueToPropertyValue($propertyType, $rawPropertyValue);
196 case (Tx_Extbase_Persistence_PropertyType
::REFERENCE
):
197 if (is_null($row->getValue($columnName))) {
198 $propertyValue = NULL;
200 $fieldValue = $row->getValue($columnMap->getColumnName());
201 $result = $this->fetchRelated($object, $propertyName, $fieldValue);
202 $propertyValue = $this->mapResultToPropertyValue($object, $propertyName, $result);
206 // FIXME throw exception
209 $object->_setProperty($propertyName, $propertyValue);
214 * Fetches a collection of objects related to a property of a parent object
216 * @param Tx_Extbase_DomainObject_AbstractEntity $parentObject The object instance this proxy is part of
217 * @param string $propertyName The name of the proxied property in it's parent
218 * @param mixed $fieldValue The raw field value.
219 * @param Tx_Extbase_Persistence_Mapper_DataMap $dataMap The corresponding Data Map of the property
220 * @return mixed The result
222 public function fetchRelated(Tx_Extbase_DomainObject_AbstractEntity
$parentObject, $propertyName, $fieldValue = '', $enableLazyLoading = TRUE) {
223 $columnMap = $this->getDataMap(get_class($parentObject))->getColumnMap($propertyName);
224 $propertyMetaData = $this->reflectionService
->getClassSchema(get_class($parentObject))->getProperty($propertyName);
225 if ($enableLazyLoading === TRUE && ($propertyMetaData['lazy'] ||
($columnMap->getLoadingStrategy() !== Tx_Extbase_Persistence_Mapper_ColumnMap
::STRATEGY_EAGER
))) {
226 if (($propertyMetaData['type'] === 'Tx_Extbase_Persistence_ObjectStorage') ||
($columnMap->getLoadingStrategy() === Tx_Extbase_Persistence_Mapper_ColumnMap
::STRATEGY_LAZY_STORAGE
)) {
227 $result = t3lib_div
::makeInstance('Tx_Extbase_Persistence_LazyObjectStorage', $parentObject, $propertyName, $fieldValue);
229 $result = t3lib_div
::makeInstance('Tx_Extbase_Persistence_LazyLoadingProxy', $parentObject, $propertyName, $fieldValue);
232 $result = $this->fetchRelatedEager($parentObject, $propertyName, $fieldValue);
238 * Fetches the related objects from the storage backend.
240 * @param Tx_Extbase_DomainObject_AbstractEntity $parentObject The object instance this proxy is part of
241 * @param string $propertyName The name of the proxied property in it's parent
242 * @param mixed $fieldValue The raw field value.
245 protected function fetchRelatedEager(Tx_Extbase_DomainObject_AbstractEntity
$parentObject, $propertyName, $fieldValue = '') {
246 $query = $this->getPreparedQuery($parentObject, $propertyName, $fieldValue);
247 return $query->execute();
251 * Builds and returns the prepared query, ready to be executed.
253 * @param Tx_Extbase_DomainObject_AbstractEntity $parentObject
254 * @param string $propertyName
255 * @param string $fieldValue
258 protected function getPreparedQuery(Tx_Extbase_DomainObject_AbstractEntity
$parentObject, $propertyName, $fieldValue = '') {
259 $columnMap = $this->getDataMap(get_class($parentObject))->getColumnMap($propertyName);
260 $queryFactory = t3lib_div
::makeInstance('Tx_Extbase_Persistence_QueryFactory');
261 $query = $queryFactory->create($columnMap->getChildClassName());
262 // TODO: This is an ugly hack, just ignoring the storage page state from here. Actually, the query settings would have to be passed into the DataMapper, so we can respect
263 // enableFields and storage page settings.
264 $query->getQuerySettings()->setRespectStoragePage(FALSE);
265 $parentKeyFieldName = $columnMap->getParentKeyFieldName();
266 $childSortByFieldName = $columnMap->getChildSortByFieldName();
267 if ($columnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_ONE
) {
268 $result = $query->matching($query->withUid(intval($fieldValue)));
269 } elseif ($columnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_MANY
) {
270 if (!empty($childSortByFieldName)) {
271 $query->setOrderings(array($childSortByFieldName => Tx_Extbase_Persistence_QueryInterface
::ORDER_ASCENDING
));
273 if (isset($parentKeyFieldName)) {
274 $result = $query->matching($query->equals($parentKeyFieldName, $parentObject->getUid()));
276 $result = $query->matching($query->equals('uid', t3lib_div
::intExplode(',', $fieldValue)));
278 } elseif ($columnMap->getTypeOfRelation() === Tx_Extbase_Persistence_Mapper_ColumnMap
::RELATION_HAS_AND_BELONGS_TO_MANY
) {
279 $relationTableName = $columnMap->getRelationTableName();
280 $left = $this->QOMFactory
->selector(NULL, $relationTableName);
281 $childClassName = $columnMap->getChildClassName();
282 $childTableName = $columnMap->getChildTableName();
283 $right = $this->QOMFactory
->selector($childClassName, $childTableName);
284 $joinCondition = $this->QOMFactory
->equiJoinCondition($relationTableName, $columnMap->getChildKeyFieldName(), $childTableName, 'uid');
285 $source = $this->QOMFactory
->join(
288 Tx_Extbase_Persistence_QOM_QueryObjectModelConstantsInterface
::JCR_JOIN_TYPE_INNER
,
291 $query->setSource($source);
292 if (!empty($childSortByFieldName)) {
293 $query->setOrderings(array($relationTableName . '.' . $childSortByFieldName => Tx_Extbase_Persistence_QueryInterface
::ORDER_ASCENDING
));
295 $result = $query->matching($query->equals($parentKeyFieldName, $parentObject->getUid()));
297 throw new Tx_Extbase_Persistence_Exception('Could not determine type of relation.', 1252502725);
303 * Returns the given result as property value of the specified property type.
305 * @param mixed $result The result could be an object or an ObjectStorage
306 * @param array $propertyMetaData The property meta data
309 public function mapResultToPropertyValue(Tx_Extbase_DomainObject_AbstractEntity
$parentObject, $propertyName, $result) {
310 $propertyMetaData = $this->reflectionService
->getClassSchema(get_class($parentObject))->getProperty($propertyName);
311 if ($result instanceof Tx_Extbase_Persistence_LoadingStrategyInterface
) {
312 $propertyValue = $result;
314 if (in_array($propertyMetaData['type'], array('array', 'ArrayObject', 'Tx_Extbase_Persistence_ObjectStorage')) && strpos($propertyMetaData['elementType'], '_') !== FALSE) {
316 foreach ($result as $value) {
320 if ($propertyMetaData['type'] === 'ArrayObject') {
321 $propertyValue = new ArrayObject($objects);
322 } elseif ($propertyMetaData['type'] === 'Tx_Extbase_Persistence_ObjectStorage') {
323 $propertyValue = new Tx_Extbase_Persistence_ObjectStorage();
324 foreach ($objects as $object) {
325 $propertyValue->attach($object);
328 $propertyValue = $objects;
330 } elseif (strpos($propertyMetaData['type'], '_') !== FALSE) {
331 $propertyValue = current($result);
334 return $propertyValue;
338 * Counts the number of related objects assigned to a property of a parent object
340 * @param Tx_Extbase_DomainObject_AbstractEntity $parentObject The object instance this proxy is part of
341 * @param string $propertyName The name of the proxied property in it's parent
342 * @param mixed $fieldValue The raw field value.
344 public function countRelated(Tx_Extbase_DomainObject_AbstractEntity
$parentObject, $propertyName, $fieldValue = '') {
345 $query = $this->getPreparedQuery($parentObject, $propertyName, $fieldValue);
346 return $query->count();
350 * Delegates the call to the Data Map.
351 * Returns TRUE if the property is persistable (configured in $TCA)
353 * @param string $className The property name
354 * @param string $propertyName The property name
355 * @return boolean TRUE if the property is persistable (configured in $TCA)
357 public function isPersistableProperty($className, $propertyName) {
358 $dataMap = $this->getDataMap($className);
359 return $dataMap->isPersistableProperty($propertyName);
363 * Returns a data map for a given class name
365 * @param string $className The class name you want to fetch the Data Map for
366 * @return Tx_Extbase_Persistence_Mapper_DataMap The data map
368 public function getDataMap($className) {
369 if (!is_string($className) ||
strlen($className) === 0) throw new Tx_Extbase_Persistence_Exception('No class name was given to retrieve the Data Map for.', 1251315965);
370 if (!isset($this->dataMaps
[$className])) {
371 // FIXME This is too expensive for table name aliases -> implement a DataMapBuilder (knowing the aliases defined in $TCA)
372 $columnMapping = array();
374 $extbaseSettings = Tx_Extbase_Dispatcher
::getExtbaseFrameworkConfiguration();
375 if (is_array($extbaseSettings['persistence']['classes'][$className])) {
376 $persistenceSettings = $extbaseSettings['persistence']['classes'][$className];
377 if (is_string($persistenceSettings['mapping']['tableName']) && strlen($persistenceSettings['mapping']['tableName']) > 0) {
378 $tableName = $persistenceSettings['mapping']['tableName'];
380 if (is_array($persistenceSettings['mapping']['columns'])) {
381 $columnMapping = $persistenceSettings['mapping']['columns'];
383 } elseif (class_exists($className)) {
384 foreach (class_parents($className) as $parentClassName) {
385 $persistenceSettings = $extbaseSettings['persistence']['classes'][$parentClassName];
386 if (is_array($persistenceSettings)) {
387 if (is_string($persistenceSettings['mapping']['tableName']) && strlen($persistenceSettings['mapping']['tableName']) > 0) {
388 $tableName = $persistenceSettings['mapping']['tableName'];
390 if (is_array($persistenceSettings['mapping']['columns'])) {
391 $columnMapping = $persistenceSettings['mapping']['columns'];
397 throw new Tx_Extbase_Persistence_Exception('Could not determine a Data Map for given class name.', 1256067130);
400 $dataMap = new Tx_Extbase_Persistence_Mapper_DataMap($className, $tableName, $columnMapping);
401 $this->dataMaps
[$className] = $dataMap;
403 return $this->dataMaps
[$className];
407 * Returns the selector (table) name for a given class name.
409 * @param string $className
410 * @return string The selector name
412 public function convertClassNameToTableName($className) {
413 return $this->getDataMap($className)->getTableName();
417 * Returns the column name for a given property name of the specified class.
419 * @param string $className
420 * @param string $propertyName
421 * @return string The column name
423 public function convertPropertyNameToColumnName($propertyName, $className = '') {
424 if (!empty($className)) {
425 $dataMap = $this->getDataMap($className);
426 if ($dataMap !== NULL) {
427 $columnMap = $dataMap->getColumnMap($propertyName);
428 if ($columnMap !== NULL) {
429 return $columnMap->getColumnName();
433 return Tx_Extbase_Utility_Extension
::convertCamelCaseToLowerCaseUnderscored($propertyName);