TYPO3 CMS  TYPO3_6-2
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Version\Dependency\ElementEntity Class Reference
Inheritance diagram for TYPO3\CMS\Version\Dependency\ElementEntity:
t3lib_utility_Dependency_Element

Public Member Functions

 __construct ($table, $id, array $data=array(), \TYPO3\CMS\Version\Dependency\DependencyResolver $dependency)
 
 setInvalid ($invalid)
 
 isInvalid ()
 
 getTable ()
 
 getId ()
 
 setId ($id)
 
 getData ()
 
 getDataValue ($key)
 
 setDataValue ($key, $value)
 
 hasDataValue ($key)
 
 __toString ()
 
 getDependency ()
 
 getChildren ()
 
 getParents ()
 
 hasReferences ()
 
 getRecord ()
 

Static Public Member Functions

static 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

 $invalid = FALSE
 
 $table
 
 $id
 
 $data
 
 $record
 
 $dependency
 
 $children
 
 $parents
 
 $traversingParents = FALSE
 
 $outerMostParent
 
 $nestedChildren
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Object to hold information on a dependent database element in abstract.

Definition at line 20 of file ElementEntity.php.

Constructor & Destructor Documentation

◆ __construct()

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

Creates this object.

Parameters
string$table
integer$id
array$data(optional)
\TYPO3\CMS\Version\Dependency\DependencyResolver$dependency

Definition at line 92 of file ElementEntity.php.

References TYPO3\CMS\Version\Dependency\ElementEntity\$data, TYPO3\CMS\Version\Dependency\ElementEntity\$dependency, TYPO3\CMS\Version\Dependency\ElementEntity\$id, and TYPO3\CMS\Version\Dependency\ElementEntity\$table.

Member Function Documentation

◆ __toString()

TYPO3\CMS\Version\Dependency\ElementEntity::__toString ( )

Converts this object for string representation.

Returns
string

Definition at line 190 of file ElementEntity.php.

◆ getChildren()

TYPO3\CMS\Version\Dependency\ElementEntity::getChildren ( )

Gets all child references.

Returns
array|ReferenceEntity[]

Definition at line 208 of file ElementEntity.php.

References TYPO3\CMS\Version\Dependency\ElementEntity\$children, $GLOBALS, and TYPO3\CMS\Version\Dependency\ElementEntity\getDependency().

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ getData()

TYPO3\CMS\Version\Dependency\ElementEntity::getData ( )

Gets the data.

Returns
array

Definition at line 146 of file ElementEntity.php.

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

◆ getDataValue()

TYPO3\CMS\Version\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 $result, and TYPO3\CMS\Version\Dependency\ElementEntity\hasDataValue().

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

◆ getDependency()

TYPO3\CMS\Version\Dependency\ElementEntity::getDependency ( )

Gets the parent dependency object.

Returns

Definition at line 199 of file ElementEntity.php.

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

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

◆ getId()

TYPO3\CMS\Version\Dependency\ElementEntity::getId ( )

Gets the id.

Returns
integer

Definition at line 128 of file ElementEntity.php.

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

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

◆ getIdentifier()

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

Converts the object for string representation.

Parameters
string$table
integer$id
Returns
string

Definition at line 331 of file ElementEntity.php.

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

Referenced by TYPO3\CMS\Version\Dependency\ElementEntityProcessor\getDataHandler().

◆ getParents()

TYPO3\CMS\Version\Dependency\ElementEntity::getParents ( )

Gets all parent references.

Returns
array|ReferenceEntity[]

Definition at line 246 of file ElementEntity.php.

References $GLOBALS, TYPO3\CMS\Version\Dependency\ElementEntity\$parents, and TYPO3\CMS\Version\Dependency\ElementEntity\getDependency().

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ getRecord()

TYPO3\CMS\Version\Dependency\ElementEntity::getRecord ( )

Gets the database record of this element.

Returns
array

Definition at line 340 of file ElementEntity.php.

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

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

◆ getTable()

TYPO3\CMS\Version\Dependency\ElementEntity::getTable ( )

Gets the table.

Returns
string

Definition at line 119 of file ElementEntity.php.

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

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

◆ hasDataValue()

TYPO3\CMS\Version\Dependency\ElementEntity::hasDataValue (   $key)

Determines whether a particular key holds data.

Parameters
string$key
Returns
bool

Definition at line 181 of file ElementEntity.php.

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

◆ hasReferences()

TYPO3\CMS\Version\Dependency\ElementEntity::hasReferences ( )

Determines whether there are child or parent references.

Returns
boolean

Definition at line 276 of file ElementEntity.php.

References TYPO3\CMS\Version\Dependency\ElementEntity\$children, TYPO3\CMS\Version\Dependency\ElementEntity\$nestedChildren, TYPO3\CMS\Version\Dependency\ElementEntity\$outerMostParent, TYPO3\CMS\Version\Dependency\ElementEntity\$parents, TYPO3\CMS\Version\Dependency\ElementEntity\getChildren(), and TYPO3\CMS\Version\Dependency\ElementEntity\getParents().

◆ isInvalid()

TYPO3\CMS\Version\Dependency\ElementEntity::isInvalid ( )
Returns
bool

Definition at line 110 of file ElementEntity.php.

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

◆ setDataValue()

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

Sets a value for a particular key in the data.

Parameters
string$key
mixed$value
Returns
void

Definition at line 171 of file ElementEntity.php.

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

◆ setId()

TYPO3\CMS\Version\Dependency\ElementEntity::setId (   $id)

Sets the id.

Parameters
int$id

Definition at line 137 of file ElementEntity.php.

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

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

◆ setInvalid()

TYPO3\CMS\Version\Dependency\ElementEntity::setInvalid (   $invalid)
Parameters
bool$invalid

Definition at line 103 of file ElementEntity.php.

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

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

Member Data Documentation

◆ $children

TYPO3\CMS\Version\Dependency\ElementEntity::$children
protected

Definition at line 62 of file ElementEntity.php.

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\getChildren(), and TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ $data

TYPO3\CMS\Version\Dependency\ElementEntity::$data
protected

Definition at line 47 of file ElementEntity.php.

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

◆ $dependency

TYPO3\CMS\Version\Dependency\ElementEntity::$dependency
protected

Definition at line 57 of file ElementEntity.php.

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

◆ $id

TYPO3\CMS\Version\Dependency\ElementEntity::$id
protected

Definition at line 42 of file ElementEntity.php.

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

◆ $invalid

TYPO3\CMS\Version\Dependency\ElementEntity::$invalid = FALSE
protected

Definition at line 32 of file ElementEntity.php.

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

◆ $nestedChildren

TYPO3\CMS\Version\Dependency\ElementEntity::$nestedChildren
protected

Definition at line 82 of file ElementEntity.php.

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ $outerMostParent

TYPO3\CMS\Version\Dependency\ElementEntity::$outerMostParent
protected

Definition at line 77 of file ElementEntity.php.

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ $parents

TYPO3\CMS\Version\Dependency\ElementEntity::$parents
protected

Definition at line 67 of file ElementEntity.php.

Referenced by TYPO3\CMS\Version\Dependency\ElementEntity\getParents(), and TYPO3\CMS\Version\Dependency\ElementEntity\hasReferences().

◆ $record

TYPO3\CMS\Version\Dependency\ElementEntity::$record
protected

Definition at line 52 of file ElementEntity.php.

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

◆ $table

TYPO3\CMS\Version\Dependency\ElementEntity::$table
protected

Definition at line 37 of file ElementEntity.php.

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

◆ $traversingParents

TYPO3\CMS\Version\Dependency\ElementEntity::$traversingParents = FALSE
protected

Definition at line 72 of file ElementEntity.php.

◆ EVENT_Construct

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

Definition at line 24 of file ElementEntity.php.

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

◆ EVENT_CreateChildReference

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

Definition at line 25 of file ElementEntity.php.

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

◆ EVENT_CreateParentReference

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

Definition at line 26 of file ElementEntity.php.

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

◆ REFERENCES_ChildOf

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

Definition at line 22 of file ElementEntity.php.

◆ REFERENCES_ParentOf

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

Definition at line 23 of file ElementEntity.php.

◆ RESPONSE_Skip

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

Definition at line 27 of file ElementEntity.php.

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