TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Version\Dependency\DependencyResolver Class Reference

Public Member Functions

 setWorkspace ($workspace)
 
 getWorkspace ()
 
 setEventCallback ($eventName, \TYPO3\CMS\Version\Dependency\EventCallback $callback)
 
 setOuterMostParentsRequireReferences ($outerMostParentsRequireReferences)
 
 addElement ($table, $id, array $data=[])
 
 getNestedElements (\TYPO3\CMS\Version\Dependency\ElementEntity $outerMostParent)
 
 getElements ()
 
 getFactory ()
 

Protected Member Functions

 processOuterMostParent (\TYPO3\CMS\Version\Dependency\ElementEntity $element)
 

Protected Attributes

 $workspace = 0
 
 $factory
 
 $elements = []
 
 $eventCallbacks = []
 
 $outerMostParentsRequireReferences = false
 
 $outerMostParents
 

Detailed Description

Object to handle and determine dependent references of elements.

Definition at line 20 of file DependencyResolver.php.

Member Function Documentation

◆ addElement()

TYPO3\CMS\Version\Dependency\DependencyResolver::addElement (   $table,
  $id,
array  $data = [] 
)

Adds an element to be checked for dependent references.

Parameters
string$table
int$id
array$data
Returns

Definition at line 123 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$outerMostParents, TYPO3\CMS\Version\Dependency\DependencyResolver\getFactory(), and TYPO3\CMS\Version\Dependency\DependencyResolver\processOuterMostParent().

◆ getElements()

TYPO3\CMS\Version\Dependency\DependencyResolver::getElements ( )

Gets the registered elements.

Returns
array

Definition at line 189 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$elements.

◆ getFactory()

TYPO3\CMS\Version\Dependency\DependencyResolver::getFactory ( )

Gets an instance of the factory to keep track of element or reference entities.

Returns

Definition at line 199 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$factory, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Version\Dependency\DependencyResolver\addElement().

◆ getNestedElements()

TYPO3\CMS\Version\Dependency\DependencyResolver::getNestedElements ( \TYPO3\CMS\Version\Dependency\ElementEntity  $outerMostParent)

Gets all nested elements (including the parent) of a particular outermost parent element.

Exceptions

Definition at line 174 of file DependencyResolver.php.

◆ getWorkspace()

TYPO3\CMS\Version\Dependency\DependencyResolver::getWorkspace ( )

Gets the current workspace.

Returns
int

Definition at line 67 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$workspace.

◆ processOuterMostParent()

TYPO3\CMS\Version\Dependency\DependencyResolver::processOuterMostParent ( \TYPO3\CMS\Version\Dependency\ElementEntity  $element)
protected

Processes and registers the outermost parents accordant to the registered elements.

Parameters
\TYPO3\CMS\Version\Dependency\ElementEntity$element
Returns
void

Definition at line 154 of file DependencyResolver.php.

Referenced by TYPO3\CMS\Version\Dependency\DependencyResolver\addElement().

◆ setEventCallback()

TYPO3\CMS\Version\Dependency\DependencyResolver::setEventCallback (   $eventName,
\TYPO3\CMS\Version\Dependency\EventCallback  $callback 
)

Sets a callback for a particular event.

Parameters
string$eventName
\TYPO3\CMS\Version\Dependency\EventCallback$callback
Returns

Definition at line 79 of file DependencyResolver.php.

◆ setOuterMostParentsRequireReferences()

TYPO3\CMS\Version\Dependency\DependencyResolver::setOuterMostParentsRequireReferences (   $outerMostParentsRequireReferences)

Sets the condition that outermost parents required at least one child or parent reference.

Parameters
bool$outerMostParentsRequireReferences
Returns

Definition at line 109 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$outerMostParentsRequireReferences.

◆ setWorkspace()

TYPO3\CMS\Version\Dependency\DependencyResolver::setWorkspace (   $workspace)

Sets the current workspace.

Parameters
int$workspace

Definition at line 57 of file DependencyResolver.php.

References TYPO3\CMS\Version\Dependency\DependencyResolver\$workspace.

Member Data Documentation

◆ $elements

TYPO3\CMS\Version\Dependency\DependencyResolver::$elements = []
protected

◆ $eventCallbacks

TYPO3\CMS\Version\Dependency\DependencyResolver::$eventCallbacks = []
protected

Definition at line 40 of file DependencyResolver.php.

◆ $factory

TYPO3\CMS\Version\Dependency\DependencyResolver::$factory
protected

◆ $outerMostParents

TYPO3\CMS\Version\Dependency\DependencyResolver::$outerMostParents
protected

◆ $outerMostParentsRequireReferences

TYPO3\CMS\Version\Dependency\DependencyResolver::$outerMostParentsRequireReferences = false
protected

◆ $workspace

TYPO3\CMS\Version\Dependency\DependencyResolver::$workspace = 0
protected