AbstractDomainObject implements DomainObjectInterface, ObjectMonitoringInterface
A generic Domain Object.
All Model domain objects need to inherit from either AbstractEntity or AbstractValueObject, as this provides important framework information.
only to be used within Extbase, not part of TYPO3 Core API.
Table of Contents
Interfaces
- DomainObjectInterface
- A Domain Object Interface. All domain objects which should be persisted need to implement the below interface.
- ObjectMonitoringInterface
- An interface how to monitor changes on an object and its properties. All domain objects which should be persisted need to implement the below interface.
Properties
- $_languageUid : int
- $_localizedUid : int
- $_versionedUid : int
- $pid : int
- $uid : int
Methods
- __clone() : mixed
- Clone method. Sets the _isClone property.
- __toString() : string
- Returns the class name and the uid of the object as string
- _getCleanProperties() : array<string|int, mixed>
- Returns a hash map of clean properties and $values.
- _getCleanProperty() : mixed
- 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.
- _getProperties() : array<string|int, mixed>
- Returns a hash map of property names and property values. Only for internal use.
- _getProperty() : mixed
- Returns the property value of the given property name. Only for internal use.
- _hasProperty() : bool
- Returns the property value of the given property name. Only for internal use.
- _isClone() : bool
- Returns TRUE if the object has been cloned, FALSE otherwise.
- _isDirty() : bool
- Returns TRUE if the properties were modified after reconstitution
- _isNew() : bool
- Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
- _memorizeCleanState() : mixed
- Register an object's clean state, e.g. after it has been reconstituted from the database.
- _memorizePropertyCleanState() : mixed
- Register a properties's clean state, e.g. after it has been reconstituted from the database.
- _setClone() : mixed
- Setter whether this Domain Object is a clone of another one.
- _setProperty() : bool
- Reconstitutes a property. Only for internal use.
- getPid() : int|null
- Getter for the pid.
- getUid() : int|null
- Getter for uid.
- setPid() : void
- Setter for the pid.
- isPropertyDirty() : bool
- Checks the $value against the $cleanState.
Properties
$_languageUid
protected
int
$_languageUid
The uid of the language of the object. This is the uid of the language record in the table sys_language.
$_localizedUid
protected
int
$_localizedUid
The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).
$_versionedUid
protected
int
$_versionedUid
The uid of the versioned record.
$pid
protected
int
$pid
The id of the page the record is "stored".
$uid
protected
int
$uid
The uid of the record. The uid is only unique in the context of the database table.
Methods
__clone()
Clone method. Sets the _isClone property.
public
__clone() : mixed
__toString()
Returns the class name and the uid of the object as string
public
__toString() : string
Return values
string_getCleanProperties()
Returns a hash map of clean properties and $values.
public
_getCleanProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>_getCleanProperty()
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.
public
_getCleanProperty(string $propertyName) : mixed
Parameters
- $propertyName : string
-
The name of the property to be memorized.
Return values
mixed —The clean property value or NULL
_getProperties()
Returns a hash map of property names and property values. Only for internal use.
public
_getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —The properties
_getProperty()
Returns the property value of the given property name. Only for internal use.
public
_getProperty(string $propertyName) : mixed
Parameters
- $propertyName : string
Return values
mixed —The propertyValue
_hasProperty()
Returns the property value of the given property name. Only for internal use.
public
_hasProperty(string $propertyName) : bool
Parameters
- $propertyName : string
Return values
bool —TRUE bool true if the property exists, FALSE if it doesn't exist or NULL in case of an error.
_isClone()
Returns TRUE if the object has been cloned, FALSE otherwise.
public
_isClone() : bool
Return values
bool —TRUE if the object has been cloned
_isDirty()
Returns TRUE if the properties were modified after reconstitution
public
_isDirty([string $propertyName = null ]) : bool
Parameters
- $propertyName : string = null
-
An optional name of a property to be checked if its value is dirty
Tags
Return values
bool_isNew()
Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
public
_isNew() : bool
Return values
bool_memorizeCleanState()
Register an object's clean state, e.g. after it has been reconstituted from the database.
public
_memorizeCleanState([string $propertyName = null ]) : mixed
Parameters
- $propertyName : string = null
-
The name of the property to be memorized. If omitted all persistable properties are memorized.
_memorizePropertyCleanState()
Register a properties's clean state, e.g. after it has been reconstituted from the database.
public
_memorizePropertyCleanState(string $propertyName) : mixed
Parameters
- $propertyName : string
-
The name of the property to be memorized. If omitted all persistable properties are memorized.
_setClone()
Setter whether this Domain Object is a clone of another one.
public
_setClone(bool $clone) : mixed
NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.
Parameters
- $clone : bool
_setProperty()
Reconstitutes a property. Only for internal use.
public
_setProperty(string $propertyName, mixed $propertyValue) : bool
Parameters
- $propertyName : string
- $propertyValue : mixed
Return values
boolgetPid()
Getter for the pid.
public
getPid() : int|null
Return values
int|null —The pid or NULL if none set yet.
getUid()
Getter for uid.
public
getUid() : int|null
Return values
int|null —The uid or NULL if none set yet.
setPid()
Setter for the pid.
public
setPid(int $pid) : void
Parameters
- $pid : int
isPropertyDirty()
Checks the $value against the $cleanState.
protected
isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
- $previousValue : mixed
- $currentValue : mixed