ElementEntity
Object to hold information on a dependent database element in abstract.
Table of Contents
Constants
- EVENT_Construct = 'TYPO3\CMS\Version\Dependency\ElementEntity::construct'
- EVENT_CreateChildReference = 'TYPO3\CMS\Version\Dependency\ElementEntity::createChildReference'
- EVENT_CreateParentReference = 'TYPO3\CMS\Version\Dependency\ElementEntity::createParentReference'
- REFERENCES_ChildOf = 'childOf'
- REFERENCES_ParentOf = 'parentOf'
- RESPONSE_Skip = 'TYPO3\CMS\Version\Dependency\ElementEntity->skip'
Properties
- $children : array<string|int, mixed>|null
- $data : array<string|int, mixed>
- $dependency : DependencyResolver
- $id : int
- $invalid : bool
- $nestedChildren : array<string|int, mixed>|null
- $outerMostParent : ElementEntity|false|null
- $parents : array<string|int, mixed>|null
- $record : array<string|int, mixed>
- $table : string
Methods
- __construct() : mixed
- __toString() : string
- Converts this object for string representation.
- getChildren() : array<string|int, ReferenceEntity>
- Gets all child references.
- getData() : array<string|int, mixed>
- Gets the data.
- getDataValue() : mixed
- Gets a value for a particular key from the data.
- getDependency() : DependencyResolver
- Gets the parent dependency object.
- getId() : int
- Gets the id.
- getIdentifier() : string
- Converts the object for string representation.
- getNestedChildren() : array<string|int, ReferenceEntity>
- Gets nested children accumulated.
- getOuterMostParent() : false|ElementEntity
- Gets the outermost parent element.
- getParents() : array<string|int, ReferenceEntity>
- Gets all parent references.
- getRecord() : array<string|int, mixed>
- Gets the database record of this element.
- getTable() : string
- Gets the table.
- hasDataValue() : bool
- Determines whether a particular key holds data.
- hasReferences() : bool
- Determines whether there are child or parent references.
- isInvalid() : bool
- setDataValue() : void
- Sets a value for a particular key in the data.
- setId() : void
- Sets the id.
- setInvalid() : void
Constants
EVENT_Construct
public
mixed
EVENT_Construct
= 'TYPO3\CMS\Version\Dependency\ElementEntity::construct'
EVENT_CreateChildReference
public
mixed
EVENT_CreateChildReference
= 'TYPO3\CMS\Version\Dependency\ElementEntity::createChildReference'
EVENT_CreateParentReference
public
mixed
EVENT_CreateParentReference
= 'TYPO3\CMS\Version\Dependency\ElementEntity::createParentReference'
REFERENCES_ChildOf
public
mixed
REFERENCES_ChildOf
= 'childOf'
REFERENCES_ParentOf
public
mixed
REFERENCES_ParentOf
= 'parentOf'
RESPONSE_Skip
public
mixed
RESPONSE_Skip
= 'TYPO3\CMS\Version\Dependency\ElementEntity->skip'
Properties
$children
protected
array<string|int, mixed>|null
$children
$data
protected
array<string|int, mixed>
$data
$dependency
protected
DependencyResolver
$dependency
$id
protected
int
$id
$invalid
protected
bool
$invalid
= false
$nestedChildren
protected
array<string|int, mixed>|null
$nestedChildren
$outerMostParent
protected
ElementEntity|false|null
$outerMostParent
$parents
protected
array<string|int, mixed>|null
$parents
$record
protected
array<string|int, mixed>
$record
$table
protected
string
$table
Methods
__construct()
public
__construct(string $table, int $id, array<string|int, mixed> $data, DependencyResolver $dependency) : mixed
Parameters
- $table : string
- $id : int
- $data : array<string|int, mixed>
- $dependency : DependencyResolver
__toString()
Converts this object for string representation.
public
__toString() : string
Return values
stringgetChildren()
Gets all child references.
public
getChildren() : array<string|int, ReferenceEntity>
Return values
array<string|int, ReferenceEntity>getData()
Gets the data.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>getDataValue()
Gets a value for a particular key from the data.
public
getDataValue(string $key) : mixed
Parameters
- $key : string
getDependency()
Gets the parent dependency object.
public
getDependency() : DependencyResolver
Return values
DependencyResolvergetId()
Gets the id.
public
getId() : int
Return values
intgetIdentifier()
Converts the object for string representation.
public
static getIdentifier(string $table, int $id) : string
Parameters
- $table : string
- $id : int
Return values
stringgetNestedChildren()
Gets nested children accumulated.
public
getNestedChildren() : array<string|int, ReferenceEntity>
Return values
array<string|int, ReferenceEntity>getOuterMostParent()
Gets the outermost parent element.
public
getOuterMostParent() : false|ElementEntity
Return values
false|ElementEntitygetParents()
Gets all parent references.
public
getParents() : array<string|int, ReferenceEntity>
Return values
array<string|int, ReferenceEntity>getRecord()
Gets the database record of this element.
public
getRecord() : array<string|int, mixed>
Return values
array<string|int, mixed>getTable()
Gets the table.
public
getTable() : string
Return values
stringhasDataValue()
Determines whether a particular key holds data.
public
hasDataValue(string $key) : bool
Parameters
- $key : string
Return values
boolhasReferences()
Determines whether there are child or parent references.
public
hasReferences() : bool
Return values
boolisInvalid()
public
isInvalid() : bool
Return values
boolsetDataValue()
Sets a value for a particular key in the data.
public
setDataValue(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
setId()
Sets the id.
public
setId(int $id) : void
Parameters
- $id : int
setInvalid()
public
setInvalid(bool $invalid) : void
Parameters
- $invalid : bool