TYPO3\CMS\Workspaces\Dependency\ElementEntity Class Reference

Public Member Functions
	__construct ($table, $id, array $data, DependencyResolver $dependency)
	setInvalid ($invalid)
bool	isInvalid ()
string	getTable ()
int	getId ()
	setId ($id)
array	getData ()
mixed	getDataValue ($key)
	setDataValue ($key, $value)
bool	hasDataValue ($key)
string	__toString ()
DependencyResolver	getDependency ()
array ReferenceEntity[]	getChildren ()
array ReferenceEntity[]	getParents ()
bool	hasReferences ()
ElementEntity bool	getOuterMostParent ()
array ReferenceEntity[]	getNestedChildren ()
array	getRecord ()

Static Public Member Functions
static string	getIdentifier ($table, $id)

Public Attributes
const	REFERENCES_ChildOf = 'childOf'
const	REFERENCES_ParentOf = 'parentOf'
const	EVENT_Construct = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::construct'
const	EVENT_CreateChildReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createChildReference'
const	EVENT_CreateParentReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createParentReference'
const	RESPONSE_Skip = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity->skip'

Protected Attributes
bool	$invalid = false
string	$table
int	$id
array	$data
array	$record
DependencyResolver	$dependency
array	$children
array	$parents
bool	$traversingParents = false
ElementEntity	$outerMostParent
array	$nestedChildren

Detailed Description

Object to hold information on a dependent database element in abstract.

Definition at line 24 of file ElementEntity.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\Dependency\ElementEntity::__construct	(		$table,
			$id,
		array	$data,
		DependencyResolver	$dependency
	)

Creates this object.

Parameters

string	$table
int	$id
array	$data	‪(optional)
DependencyResolver	$dependency

Definition at line 85 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$data, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$dependency, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$id, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$table, and TYPO3\CMS\Workspaces\Dependency\DependencyResolver\executeEventCallback().

Member Function Documentation

__toString()

string TYPO3\CMS\Workspaces\Dependency\ElementEntity::__toString

(

)

Converts this object for string representation.

Returns

‪string

Definition at line 192 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\getIdentifier().

Referenced by TYPO3\CMS\Workspaces\Dependency\DependencyResolver\addElement(), TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\getCollectionChildrenCount(), TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getNestedElements(), TYPO3\CMS\Workspaces\Dependency\DependencyEntityFactory\getReference(), TYPO3\CMS\Workspaces\Dependency\DependencyResolver\processOuterMostParent(), and TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\resolveDataArrayChildDependencies().

getChildren()

array ReferenceEntity [] TYPO3\CMS\Workspaces\Dependency\ElementEntity::getChildren

(

)

Gets all child references.

Returns

‪array|ReferenceEntity[]

Definition at line 212 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$children, TYPO3\CMS\Workspaces\Dependency\ElementEntity\getDependency(), TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getFactory(), TYPO3\CMS\Workspaces\Dependency\DependencyEntityFactory\getReferencedElement(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\REFERENCES_ChildOf.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getNestedChildren(), TYPO3\CMS\Workspaces\Dependency\ElementEntity\hasReferences(), and TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\resolveDataArrayChildDependencies().

getData()

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::getData

(

)

Gets the data.

Returns

‪array

Definition at line 145 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$data.

getDataValue()

mixed TYPO3\CMS\Workspaces\Dependency\ElementEntity::getDataValue

(

$key

)

Gets a value for a particular key from the data.

Parameters

string

$key

Returns

‪mixed

Definition at line 156 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\hasDataValue().

Referenced by TYPO3\CMS\Workspaces\DataHandler\CommandMap\getCommonClearPropertiesCallback(), TYPO3\CMS\Workspaces\DataHandler\CommandMap\getCommonSetStagePropertiesCallback(), TYPO3\CMS\Workspaces\DataHandler\CommandMap\getCommonSwapPropertiesCallback(), and TYPO3\CMS\Workspaces\DataHandler\CommandMap\getElementLiveIdCallback().

getDependency()

DependencyResolver TYPO3\CMS\Workspaces\Dependency\ElementEntity::getDependency

(

)

Gets the parent dependency object.

Returns

‪DependencyResolver

Definition at line 202 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$dependency.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getChildren(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getParents().

getId()

int TYPO3\CMS\Workspaces\Dependency\ElementEntity::getId

(

)

Gets the id.

Returns

‪int

Definition at line 125 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$id.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback(), TYPO3\CMS\Workspaces\DataHandler\CommandMap\getElementIdCallback(), TYPO3\CMS\Workspaces\DataHandler\CommandMap\getElementSwapPropertiesCallback(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getRecord().

getIdentifier()

static string TYPO3\CMS\Workspaces\Dependency\ElementEntity::getIdentifier (   $table,   $id  )

static

Converts the object for string representation.

Parameters

string	$table
int	$id

Returns

‪string

Definition at line 396 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$id, and TYPO3\CMS\Workspaces\Dependency\ElementEntity\$table.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\__toString(), and TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\transformDependentElementsToUseLiveId().

getNestedChildren()

array ReferenceEntity [] TYPO3\CMS\Workspaces\Dependency\ElementEntity::getNestedChildren

(

)

Gets nested children accumulated.

Returns

‪array|ReferenceEntity[]

Definition at line 376 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$children, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$nestedChildren, and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getChildren().

Referenced by TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getNestedElements().

getOuterMostParent()

ElementEntity bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::getOuterMostParent

(

)

Gets the outermost parent element.

Returns

‪ElementEntity|bool

Definition at line 347 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$outerMostParent, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$parents, TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getParents().

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent(), and TYPO3\CMS\Workspaces\Dependency\DependencyResolver\processOuterMostParent().

getParents()

array ReferenceEntity [] TYPO3\CMS\Workspaces\Dependency\ElementEntity::getParents

(

)

Gets all parent references.

Returns

‪array|ReferenceEntity[]

Definition at line 274 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$parents, TYPO3\CMS\Workspaces\Dependency\ElementEntity\getDependency(), TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getFactory(), TYPO3\CMS\Workspaces\Dependency\DependencyEntityFactory\getReferencedElement(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\REFERENCES_ParentOf.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\hasReferences().

getRecord()

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::getRecord

(

)

Gets the database record of this element.

Returns

‪array

Definition at line 406 of file ElementEntity.php.

References $GLOBALS, TYPO3\CMS\Workspaces\Dependency\ElementEntity\$record, TYPO3\CMS\Workspaces\Dependency\ElementEntity\getId(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getTable().

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback().

getTable()

string TYPO3\CMS\Workspaces\Dependency\ElementEntity::getTable

(

)

Gets the table.

Returns

‪string

Definition at line 115 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$table.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback(), TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementChildReferenceCallback(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getRecord().

hasDataValue()

bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::hasDataValue

(

$key

)

Determines whether a particular key holds data.

Parameters

string

$key

Returns

‪bool

Definition at line 182 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getDataValue().

hasReferences()

bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::hasReferences

(

)

Determines whether there are child or parent references.

Returns

‪bool

Definition at line 337 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\getChildren(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getParents().

Referenced by TYPO3\CMS\Workspaces\Dependency\DependencyResolver\processOuterMostParent().

isInvalid()

bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::isInvalid

(

)

Returns

‪bool

Definition at line 105 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$invalid.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementChildReferenceCallback().

setDataValue()

TYPO3\CMS\Workspaces\Dependency\ElementEntity::setDataValue	(		$key,
			$value
	)

Sets a value for a particular key in the data.

Parameters

string	$key
mixed	$value

Definition at line 171 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback().

setId()

TYPO3\CMS\Workspaces\Dependency\ElementEntity::setId

(

$id

)

Sets the id.

Parameters

int

$id

Definition at line 135 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$id.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback().

setInvalid()

TYPO3\CMS\Workspaces\Dependency\ElementEntity::setInvalid

(

$invalid

)

Parameters

bool

$invalid

Definition at line 97 of file ElementEntity.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\$invalid.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementCallback().

Member Data Documentation

$children

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::$children

protected

Definition at line 59 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getChildren(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getNestedChildren().

$data

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::$data

protected

Definition at line 47 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\__construct(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getData().

$dependency

DependencyResolver TYPO3\CMS\Workspaces\Dependency\ElementEntity::$dependency

protected

Definition at line 55 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\__construct(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getDependency().

$id

int TYPO3\CMS\Workspaces\Dependency\ElementEntity::$id

protected

Definition at line 43 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\__construct(), TYPO3\CMS\Workspaces\Dependency\ElementEntity\getId(), TYPO3\CMS\Workspaces\Dependency\ElementEntity\getIdentifier(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\setId().

$invalid

bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::$invalid = false

protected

Definition at line 35 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\isInvalid(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\setInvalid().

$nestedChildren

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::$nestedChildren

protected

Definition at line 75 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getNestedChildren().

$outerMostParent

ElementEntity TYPO3\CMS\Workspaces\Dependency\ElementEntity::$outerMostParent

protected

Definition at line 71 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent().

$parents

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::$parents

protected

Definition at line 63 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getParents().

$record

array TYPO3\CMS\Workspaces\Dependency\ElementEntity::$record

protected

Definition at line 51 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getRecord().

$table

string TYPO3\CMS\Workspaces\Dependency\ElementEntity::$table

protected

Definition at line 39 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\__construct(), TYPO3\CMS\Workspaces\Dependency\ElementEntity\getIdentifier(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getTable().

$traversingParents

bool TYPO3\CMS\Workspaces\Dependency\ElementEntity::$traversingParents = false

protected

Definition at line 67 of file ElementEntity.php.

EVENT_Construct

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::EVENT_Construct = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::construct'

Definition at line 28 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\getDependencyResolver(), and TYPO3\CMS\Workspaces\DataHandler\CommandMap\getDependencyUtility().

EVENT_CreateChildReference

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::EVENT_CreateChildReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createChildReference'

Definition at line 29 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\getDependencyResolver(), and TYPO3\CMS\Workspaces\DataHandler\CommandMap\getDependencyUtility().

EVENT_CreateParentReference

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::EVENT_CreateParentReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createParentReference'

Definition at line 30 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Service\Dependency\CollectionService\getDependencyResolver(), and TYPO3\CMS\Workspaces\DataHandler\CommandMap\getDependencyUtility().

REFERENCES_ChildOf

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::REFERENCES_ChildOf = 'childOf'

Definition at line 26 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getChildren().

REFERENCES_ParentOf

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::REFERENCES_ParentOf = 'parentOf'

Definition at line 27 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntity\getParents().

RESPONSE_Skip

const TYPO3\CMS\Workspaces\Dependency\ElementEntity::RESPONSE_Skip = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity->skip'

Definition at line 31 of file ElementEntity.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createClearDependentElementChildReferenceCallback(), TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createClearDependentElementParentReferenceCallback(), TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementChildReferenceCallback(), and TYPO3\CMS\Workspaces\Dependency\ElementEntityProcessor\createNewDependentElementParentReferenceCallback().