TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface:

Public Member Functions
int	getUid ()
	setPid (int $pid)
int	getPid ()
bool	_isNew ()
	_setProperty (string $propertyName, $value)
mixed	_getProperty (string $propertyName)
array	_getProperties ()
mixed	_getCleanProperty (string $propertyName)

Detailed Description

A Domain Object Interface. All domain objects which should be persisted need to implement the below interface. Usually you will need to subclass \TYPO3\CMS\Extbase\DomainObject\AbstractEntity and \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject instead.

See also

‪\TYPO3\CMS\Extbase\DomainObject\AbstractEntity

‪\TYPO3\CMS\Extbase\DomainObject\AbstractValueObject

Definition at line 28 of file DomainObjectInterface.php.

Member Function Documentation

_getCleanProperty()

mixed TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::_getCleanProperty

(

string

$propertyName

)

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

Parameters

string

$propertyName

‪The name of the property to be memorized.

Returns

‪mixed The clean property value or NULL

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Backend\getRemovedChildObjects(), and TYPO3\CMS\Extbase\Persistence\Generic\Backend\persistObjectStorage().

_getProperties()

array TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::_getProperties

(

)

Returns a hash map of property names and property values

Returns

‪array The properties

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

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

_getProperty()

mixed TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::_getProperty

(

string

$propertyName

)

Returns the property value of the given property name. Only for internal use.

Parameters

string

$propertyName

Returns

‪mixed The propertyValue

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Backend\attachObjectToParentObjectRelationHasMany(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getConstraint(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\getPreparedQuery(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\getRemovedChildObjects(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\insertObject(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\insertRelationInRelationtable(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\resolveRelationValuesOfField(), and TYPO3\CMS\Extbase\Persistence\Generic\Backend\updateObject().

_isNew()

bool TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::_isNew

(

)

Returns TRUE if the object is new (the uid was not set, yet). Only for internal use

Returns

‪bool

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Backend\addCommonDateFieldsToRow(), and TYPO3\CMS\Extbase\Persistence\Generic\Backend\addCommonFieldsToRow().

_setProperty()

TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::_setProperty	(	string	$propertyName,
			$value
	)

Reconstitutes a property. Only for internal use.

Parameters

string	$propertyName
mixed	$value

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

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

getPid()

int TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::getPid

(

)

Getter for the pid.

Returns

‪int The pid or NULL if none set yet.

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

getUid()

int TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::getUid

(

)

Getter for uid.

Returns

‪int The uid or NULL if none set yet.

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Backend\attachObjectToParentObjectRelationHasMany(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\deleteAllRelationsFromRelationtable(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\deleteRelationFromRelationtable(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\fetchMaxSortingFromParentTable(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\insertRelationInRelationtable(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\removeEntity(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\resolveRelationValuesOfField(), TYPO3\CMS\Extbase\Persistence\Generic\Backend\updateObject(), and TYPO3\CMS\Extbase\Persistence\Generic\Backend\updateRelationInRelationTable().

setPid()

TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface::setPid

(

int

$pid

)

Setter for the pid.

Parameters

int

$pid

Implemented in TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Backend\insertObject().