‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper Class Reference

Public Member Functions

 __construct (?QueryInterface $query=null)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectQomFactory (\TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory $qomFactory)
 
 injectPersistenceSession (\TYPO3\CMS\Extbase\Persistence\Generic\Session $persistenceSession)
 
 injectDataMapFactory (\TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory $dataMapFactory)
 
 injectQueryFactory (\TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface $queryFactory)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
array map ($className, array $rows)
 
string getTargetType ($className, array $row)
 
TYPO3 CMS Extbase Persistence Generic LazyObjectStorage Persistence QueryResultInterface fetchRelated (DomainObjectInterface $parentObject, $propertyName, $fieldValue='', $enableLazyLoading=true)
 
mixed mapResultToPropertyValue (DomainObjectInterface $parentObject, $propertyName, $result)
 
int countRelated (DomainObjectInterface $parentObject, $propertyName, $fieldValue='')
 
bool isPersistableProperty ($className, $propertyName)
 
DataMap getDataMap ($className)
 
string convertClassNameToTableName ($className)
 
string convertPropertyNameToColumnName ($propertyName, $className=null)
 
string getType ($parentClassName, $propertyName)
 
int string getPlainValue ($input, $columnMap=null)
 

Protected Member Functions

object mapSingleRow ($className, array $row)
 
 emitAfterMappingSingleRow (DomainObjectInterface $object)
 
object createEmptyObject ($className)
 
 thawProperties (DomainObjectInterface $object, array $row)
 
TYPO3 CMS Core Type TypeInterface mapCoreType ($type, $value)
 
DateTimeInterface mapDateTime ($value, $storageFormat=null, $targetType=\DateTime::class)
 
mixed fetchRelatedEager (DomainObjectInterface $parentObject, $propertyName, $fieldValue='')
 
array null getEmptyRelationValue (DomainObjectInterface $parentObject, $propertyName)
 
Persistence QueryResultInterface getNonEmptyRelationValue (DomainObjectInterface $parentObject, $propertyName, $fieldValue)
 
Persistence QueryInterface getPreparedQuery (DomainObjectInterface $parentObject, $propertyName, $fieldValue='')
 
TYPO3 CMS Extbase Persistence Generic Qom ConstraintInterface getConstraint (Persistence\QueryInterface $query, DomainObjectInterface $parentObject, $propertyName, $fieldValue='', $relationTableMatchFields=[])
 
TYPO3 CMS Extbase Persistence Generic Qom SourceInterface getSource (DomainObjectInterface $parentObject, $propertyName)
 
mixed mapObjectToClassProperty (DomainObjectInterface $parentObject, $propertyName, $fieldValue)
 
bool propertyMapsByForeignKey (DomainObjectInterface $parentObject, $propertyName)
 

Protected Attributes

TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Persistence Generic Qom QueryObjectModelFactory $qomFactory
 
TYPO3 CMS Extbase Persistence Generic Session $persistenceSession
 
TYPO3 CMS Frontend Page PageRepository $pageSelectObject
 
TYPO3 CMS Extbase Persistence Generic Mapper DataMapFactory $dataMapFactory
 
TYPO3 CMS Extbase Persistence Generic QueryFactoryInterface $queryFactory
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
ConfigurationManagerInterface $configurationManager
 
QueryInterface $query
 

Detailed Description

A mapper to map database tables configured in $TCA on domain objects.

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 31 of file DataMapper.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::__construct ( ?QueryInterface  $query = null)

DataMapper constructor.

Parameters
?QueryInterface‪$query

Definition at line 79 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$query.

Member Function Documentation

◆ convertClassNameToTableName()

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::convertClassNameToTableName (   $className)

Returns the selector (table) name for a given class name.

Parameters
string$className
Returns
‪string The selector name

Definition at line 689 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getTableName().

◆ convertPropertyNameToColumnName()

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::convertPropertyNameToColumnName (   $propertyName,
  $className = null 
)

Returns the column name for a given property name of the specified class.

Parameters
string$propertyName
string$className
Returns
‪string The column name

Definition at line 701 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap().

◆ countRelated()

int TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::countRelated ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue = '' 
)

Counts the number of related objects assigned to a property of a parent object

Parameters
DomainObjectInterface$parentObject‪The object instance this proxy is part of
string$propertyName‪The name of the proxied property in it's parent
mixed$fieldValue‪The raw field value.
Returns
‪int

Definition at line 648 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$query, TYPO3\CMS\Extbase\Persistence\QueryInterface\execute(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

◆ createEmptyObject()

object TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::createEmptyObject (   $className)
protected

Creates a skeleton of the specified object

Parameters
string$className‪Name of the class to create a skeleton for
Exceptions
CannotReconstituteObjectException
Returns
‪object The object skeleton

Definition at line 226 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapSingleRow().

◆ emitAfterMappingSingleRow()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::emitAfterMappingSingleRow ( DomainObjectInterface  $object)
protected

Emits a signal after mapping a single row.

Parameters
DomainObjectInterface$object‪The mapped object

Definition at line 214 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapSingleRow().

◆ fetchRelated()

TYPO3 CMS Extbase Persistence Generic LazyObjectStorage Persistence QueryResultInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::fetchRelated ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue = '',
  $enableLazyLoading = true 
)

Fetches a collection of objects related to a property of a parent object

Parameters
DomainObjectInterface$parentObject‪The object instance this proxy is part of
string$propertyName‪The name of the proxied property in it's parent
mixed$fieldValue‪The raw field value.
bool$enableLazyLoading‪A flag indication if the related objects should be lazy loaded
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\LazyObjectStorage|Persistence\QueryResultInterface The result

Definition at line 392 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelatedEager().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapObjectToClassProperty(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ fetchRelatedEager()

mixed TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::fetchRelatedEager ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue = '' 
)
protected

Fetches the related objects from the storage backend.

Parameters
DomainObjectInterface$parentObject‪The object instance this proxy is part of
string$propertyName‪The name of the proxied property in it's parent
mixed$fieldValue‪The raw field value.
Returns
‪mixed

Definition at line 419 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getEmptyRelationValue(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getNonEmptyRelationValue().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelated().

◆ getConstraint()

TYPO3 CMS Extbase Persistence Generic Qom ConstraintInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getConstraint ( Persistence\QueryInterface  $query,
DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue = '',
  $relationTableMatchFields = [] 
)
protected

Builds and returns the constraint for multi value properties.

Parameters
Persistence\QueryInterface$query
DomainObjectInterface$parentObject
string$propertyName
string$fieldValue
array$relationTableMatchFields
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface $constraint

Definition at line 508 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$query, TYPO3\CMS\Extbase\Persistence\QueryInterface\equals(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getColumnMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), TYPO3\CMS\Extbase\Persistence\QueryInterface\in(), and TYPO3\CMS\Extbase\Persistence\QueryInterface\logicalAnd().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

◆ getDataMap()

DataMap TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getDataMap (   $className)

Returns a data map for a given class name

Parameters
string$className‪The class name you want to fetch the Data Map for
Exceptions
Persistence

Definition at line 675 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\convertClassNameToTableName(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\convertPropertyNameToColumnName(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getEmptyRelationValue(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getTargetType(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\isPersistableProperty(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\propertyMapsByForeignKey(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ getEmptyRelationValue()

array null TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getEmptyRelationValue ( DomainObjectInterface  $parentObject,
  $propertyName 
)
protected
Parameters
DomainObjectInterface$parentObject
string$propertyName
Returns
‪array|null

Definition at line 429 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getColumnMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getTypeOfRelation(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_ONE.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelatedEager(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapObjectToClassProperty().

◆ getNonEmptyRelationValue()

Persistence QueryResultInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getNonEmptyRelationValue ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue 
)
protected
Parameters
DomainObjectInterface$parentObject
string$propertyName
string$fieldValue
Returns
‪Persistence\QueryResultInterface

Definition at line 442 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$query, TYPO3\CMS\Extbase\Persistence\QueryInterface\execute(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelatedEager().

◆ getPlainValue()

int string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getPlainValue (   $input,
  $columnMap = null 
)

Returns a plain value, i.e. objects are flattened out if possible. Multi value objects or arrays will be converted to a comma-separated list for use in IN SQL queries.

Parameters
mixed$input‪The value that will be converted.
ColumnMap$columnMap‪Optional column map for retrieving the date storage format.
Exceptions

Definition at line 746 of file DataMapper.php.

References TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isCoreType(), and TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isValidTypeForMultiValueComparison().

◆ getPreparedQuery()

Persistence QueryInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getPreparedQuery ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue = '' 
)
protected

Builds and returns the prepared query, ready to be executed.

Parameters
DomainObjectInterface$parentObject
string$propertyName
string$fieldValue
Returns
‪Persistence\QueryInterface

Definition at line 456 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$query, TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface\_getProperty(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), TYPO3\CMS\Extbase\Persistence\QueryInterface\getQuerySettings(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getType(), TYPO3\CMS\Extbase\Persistence\QueryInterface\matching(), TYPO3\CMS\Extbase\Persistence\QueryInterface\ORDER_ASCENDING, TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_AND_BELONGS_TO_MANY, TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\RELATION_HAS_MANY, TYPO3\CMS\Extbase\Persistence\QueryInterface\setOrderings(), and TYPO3\CMS\Extbase\Persistence\QueryInterface\setSource().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\countRelated(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getNonEmptyRelationValue().

◆ getSource()

TYPO3 CMS Extbase Persistence Generic Qom SourceInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getSource ( DomainObjectInterface  $parentObject,
  $propertyName 
)
protected

Builds and returns the source to build a join for a m:n relation.

Parameters
DomainObjectInterface$parentObject
string$propertyName
Returns
‪\TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $source

Definition at line 537 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getColumnMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getType(), and TYPO3\CMS\Extbase\Persistence\Generic\Query\JCR_JOIN_TYPE_INNER.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

◆ getTargetType()

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getTargetType (   $className,
array  $row 
)

Returns the target type for the given row.

Parameters
string$className‪The name of the class
array$row‪A single array with field_name => value pairs
Returns
‪string The target type (a class name)

Definition at line 171 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getRecordType().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\map().

◆ getType()

string TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::getType (   $parentClassName,
  $propertyName 
)

Returns the type of a child object.

Parameters
string$parentClassName‪The class name of the object this proxy is part of
string$propertyName‪The name of the proxied property in it's parent
Exceptions
UnexpectedTypeException
Returns
‪string The class name of the child object

Definition at line 723 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getSource().

◆ injectConfigurationManager()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectConfigurationManager ( ConfigurationManagerInterface  $configurationManager)
Parameters
\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface$configurationManager

Definition at line 143 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$configurationManager.

◆ injectDataMapFactory()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectDataMapFactory ( \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory  $dataMapFactory)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory$dataMapFactory

Definition at line 111 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$dataMapFactory.

◆ injectObjectManager()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager

Definition at line 127 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$objectManager.

◆ injectPersistenceSession()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectPersistenceSession ( \TYPO3\CMS\Extbase\Persistence\Generic\Session  $persistenceSession)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\Session$persistenceSession

Definition at line 103 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$persistenceSession.

◆ injectQomFactory()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectQomFactory ( \TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory  $qomFactory)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory$qomFactory

Definition at line 95 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$qomFactory.

◆ injectQueryFactory()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectQueryFactory ( \TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface  $queryFactory)
Parameters
\TYPO3\CMS\Extbase\Persistence\Generic\QueryFactoryInterface$queryFactory

Definition at line 119 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$queryFactory.

◆ injectReflectionService()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectReflectionService ( \TYPO3\CMS\Extbase\Reflection\ReflectionService  $reflectionService)
Parameters
\TYPO3\CMS\Extbase\Reflection\ReflectionService$reflectionService

Definition at line 87 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$reflectionService.

◆ injectSignalSlotDispatcher()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::injectSignalSlotDispatcher ( \TYPO3\CMS\Extbase\SignalSlot\Dispatcher  $signalSlotDispatcher)
Parameters
\TYPO3\CMS\Extbase\SignalSlot\Dispatcher$signalSlotDispatcher

Definition at line 135 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\$signalSlotDispatcher.

◆ isPersistableProperty()

bool TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::isPersistableProperty (   $className,
  $propertyName 
)

Delegates the call to the Data Map. Returns TRUE if the property is persistable (configured in $TCA)

Parameters
string$className‪The property name
string$propertyName‪The property name
Returns
‪bool TRUE if the property is persistable (configured in $TCA)

Definition at line 662 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap().

◆ map()

array TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::map (   $className,
array  $rows 
)

Maps the given rows on objects

Parameters
string$className‪The name of the class
array$rows‪An array of arrays with field_name => value pairs
Returns
‪array An array of objects of the given class

Definition at line 155 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getTargetType(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapSingleRow().

◆ mapCoreType()

TYPO3 CMS Core Type TypeInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::mapCoreType (   $type,
  $value 
)
protected

Map value to a core type

Parameters
string$type
mixed$value
Returns
‪\TYPO3\CMS\Core\Type\TypeInterface

Definition at line 350 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ mapDateTime()

DateTimeInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::mapDateTime (   $value,
  $storageFormat = null,
  $targetType = \DateTime::class 
)
protected

Creates a DateTime from an unix timestamp or date/datetime/time value. If the input is empty, NULL is returned.

Parameters
int | string$value‪Unix timestamp or date/datetime/time value
string | null$storageFormat‪Storage format for native date/datetime/time fields
string | null$targetType‪The object class name to be created
Returns
‪\DateTimeInterface

Definition at line 364 of file DataMapper.php.

References TYPO3\CMS\Core\Database\Query\QueryHelper\getDateTimeTypes().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ mapObjectToClassProperty()

mixed TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::mapObjectToClassProperty ( DomainObjectInterface  $parentObject,
  $propertyName,
  $fieldValue 
)
protected

Returns the mapped classProperty from the identiyMap or mapResultToPropertyValue()

If the field value is empty and the column map has no parent key field name, the relation will be empty. If the persistence session has a registered object of the correct type and identity (fieldValue), this function returns that object. Otherwise, it proceeds with mapResultToPropertyValue().

Parameters
DomainObjectInterface$parentObject
string$propertyName
mixed$fieldValue‪the raw field value
Returns
‪mixed
See also
‪mapResultToPropertyValue()

Definition at line 563 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelated(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getEmptyRelationValue(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapResultToPropertyValue(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\propertyMapsByForeignKey().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ mapResultToPropertyValue()

mixed TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::mapResultToPropertyValue ( DomainObjectInterface  $parentObject,
  $propertyName,
  $result 
)

Returns the given result as property value of the specified property type.

Parameters
DomainObjectInterface$parentObject
string$propertyName
mixed$result‪The result
Returns
‪mixed

Definition at line 606 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapObjectToClassProperty(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

◆ mapSingleRow()

object TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::mapSingleRow (   $className,
array  $row 
)
protected

Maps a single row on an object of the given class

Parameters
string$className‪The name of the target class
array$row‪A single array with field_name => value pairs
Returns
‪object An object of the given class

Definition at line 194 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\createEmptyObject(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\emitAfterMappingSingleRow(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\thawProperties().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\map().

◆ propertyMapsByForeignKey()

bool TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::propertyMapsByForeignKey ( DomainObjectInterface  $parentObject,
  $propertyName 
)
protected

Checks if the relation is based on a foreign key.

Parameters
DomainObjectInterface$parentObject
string$propertyName
Returns
‪bool TRUE if the property is mapped

Definition at line 592 of file DataMapper.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMap\getColumnMap(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap\getParentKeyFieldName().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapObjectToClassProperty().

◆ thawProperties()

TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::thawProperties ( DomainObjectInterface  $object,
array  $row 
)
protected

Sets the given properties on the object.

Parameters
DomainObjectInterface$object‪The object to set properties on
array$row
Exceptions
Exception

Definition at line 246 of file DataMapper.php.

References $GLOBALS, TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface\_getProperties(), TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface\_setProperty(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\fetchRelated(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getDataMap(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isCoreType(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapCoreType(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapDateTime(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapObjectToClassProperty(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapResultToPropertyValue().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\mapSingleRow().

Member Data Documentation

◆ $configurationManager

ConfigurationManagerInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$configurationManager
protected

Definition at line 69 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectConfigurationManager().

◆ $dataMapFactory

TYPO3 CMS Extbase Persistence Generic Mapper DataMapFactory TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$dataMapFactory
protected

Definition at line 53 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectDataMapFactory().

◆ $objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$objectManager
protected

Definition at line 61 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectObjectManager().

◆ $pageSelectObject

TYPO3 CMS Frontend Page PageRepository TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$pageSelectObject
protected

A reference to the page select object providing methods to perform language and work space overlays

Definition at line 49 of file DataMapper.php.

◆ $persistenceSession

TYPO3 CMS Extbase Persistence Generic Session TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$persistenceSession
protected

Definition at line 43 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectPersistenceSession().

◆ $qomFactory

TYPO3 CMS Extbase Persistence Generic Qom QueryObjectModelFactory TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$qomFactory
protected

Definition at line 39 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectQomFactory().

◆ $query

QueryInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$query
protected

Definition at line 73 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\__construct(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\countRelated(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getNonEmptyRelationValue(), and TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery().

◆ $queryFactory

TYPO3 CMS Extbase Persistence Generic QueryFactoryInterface TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$queryFactory
protected

Definition at line 57 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectQueryFactory().

◆ $reflectionService

TYPO3 CMS Extbase Reflection ReflectionService TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$reflectionService
protected

Definition at line 35 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectReflectionService().

◆ $signalSlotDispatcher

TYPO3 CMS Extbase SignalSlot Dispatcher TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper::$signalSlotDispatcher
protected

Definition at line 65 of file DataMapper.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\injectSignalSlotDispatcher().