TYPO3\CMS\Workspaces\Dependency\DependencyResolver Class Reference

Public Member Functions
	setWorkspace ($workspace)
int	getWorkspace ()
DependencyResolver	setEventCallback ($eventName, EventCallback $callback)
mixed	executeEventCallback ($eventName, $caller, array $callerArguments=[])
DependencyResolver	setOuterMostParentsRequireReferences ($outerMostParentsRequireReferences)
ElementEntity	addElement ($table, $id, array $data=[])
array ElementEntity[]	getOuterMostParents ()
array	getNestedElements (ElementEntity $outerMostParent)
array	getElements ()
DependencyEntityFactory	getFactory ()

Protected Member Functions
	processOuterMostParent (ElementEntity $element)

Protected Attributes
int	$workspace = 0
DependencyEntityFactory	$factory
array	$elements = array( )
array	$eventCallbacks = array( )
bool	$outerMostParentsRequireReferences = false
array	$outerMostParents

Detailed Description

Object to handle and determine dependent references of elements.

Definition at line 23 of file DependencyResolver.php.

Member Function Documentation

addElement()

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

Adds an element to be checked for dependent references.

Parameters

string	$table
int	$id
array	$data

Returns

‪ElementEntity

Definition at line 120 of file DependencyResolver.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\__toString(), TYPO3\CMS\Workspaces\Dependency\DependencyEntityFactory\getElement(), and TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getFactory().

Referenced by TYPO3\CMS\Workspaces\DataHandler\CommandMap\addWorkspacesSetStageElements(), and TYPO3\CMS\Workspaces\DataHandler\CommandMap\addWorkspacesSwapElements().

executeEventCallback()

mixed TYPO3\CMS\Workspaces\Dependency\DependencyResolver::executeEventCallback	(		$eventName,
			$caller,
		array	$callerArguments = []
	)

Executes a registered callback (if any) for a particular event.

Parameters

string	$eventName
object	$caller
array	$callerArguments

Returns

‪mixed

Definition at line 90 of file DependencyResolver.php.

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

getElements()

array TYPO3\CMS\Workspaces\Dependency\DependencyResolver::getElements

(

)

Gets the registered elements.

Returns

‪array

Definition at line 185 of file DependencyResolver.php.

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

Referenced by TYPO3\CMS\Workspaces\DataHandler\CommandMap\applyWorkspacesDependencies().

getFactory()

DependencyEntityFactory TYPO3\CMS\Workspaces\Dependency\DependencyResolver::getFactory

(

)

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

Returns

‪DependencyEntityFactory

Definition at line 195 of file DependencyResolver.php.

References TYPO3\CMS\Workspaces\Dependency\DependencyResolver\$factory.

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

getNestedElements()

array TYPO3\CMS\Workspaces\Dependency\DependencyResolver::getNestedElements

(

ElementEntity

$outerMostParent

)

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

Exceptions

Definition at line 170 of file DependencyResolver.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\__toString(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\getNestedChildren().

Referenced by TYPO3\CMS\Workspaces\DataHandler\CommandMap\applyWorkspacesDependencies().

getOuterMostParents()

array ElementEntity [] TYPO3\CMS\Workspaces\Dependency\DependencyResolver::getOuterMostParents

(

)

Gets the outermost parents that define complete dependent structure each.

Returns

‪array|ElementEntity[]

Definition at line 133 of file DependencyResolver.php.

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

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

getWorkspace()

int TYPO3\CMS\Workspaces\Dependency\DependencyResolver::getWorkspace

(

)

Gets the current workspace.

Returns

‪int

Definition at line 64 of file DependencyResolver.php.

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

processOuterMostParent()

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

protected

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

Parameters

ElementEntity

$element

Definition at line 150 of file DependencyResolver.php.

References TYPO3\CMS\Workspaces\Dependency\ElementEntity\__toString(), TYPO3\CMS\Workspaces\Dependency\ElementEntity\getOuterMostParent(), and TYPO3\CMS\Workspaces\Dependency\ElementEntity\hasReferences().

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

setEventCallback()

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

Sets a callback for a particular event.

Parameters

string	$eventName
EventCallback	$callback

Returns

‪DependencyResolver

Definition at line 76 of file DependencyResolver.php.

setOuterMostParentsRequireReferences()

DependencyResolver TYPO3\CMS\Workspaces\Dependency\DependencyResolver::setOuterMostParentsRequireReferences

(

$outerMostParentsRequireReferences

)

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

Parameters

bool

$outerMostParentsRequireReferences

Returns

‪DependencyResolver

Definition at line 106 of file DependencyResolver.php.

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

setWorkspace()

TYPO3\CMS\Workspaces\Dependency\DependencyResolver::setWorkspace

(

$workspace

)

Sets the current workspace.

Parameters

int

$workspace

Definition at line 54 of file DependencyResolver.php.

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

Member Data Documentation

$elements

array TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$elements = array( )

protected

Definition at line 35 of file DependencyResolver.php.

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

$eventCallbacks

array TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$eventCallbacks = array( )

protected

Definition at line 39 of file DependencyResolver.php.

$factory

DependencyEntityFactory TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$factory

protected

Definition at line 31 of file DependencyResolver.php.

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

$outerMostParents

array TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$outerMostParents

protected

Definition at line 47 of file DependencyResolver.php.

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

$outerMostParentsRequireReferences

bool TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$outerMostParentsRequireReferences = false

protected

Definition at line 43 of file DependencyResolver.php.

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

$workspace

int TYPO3\CMS\Workspaces\Dependency\DependencyResolver::$workspace = 0

protected

Definition at line 27 of file DependencyResolver.php.

Referenced by TYPO3\CMS\Workspaces\Dependency\DependencyResolver\getWorkspace(), and TYPO3\CMS\Workspaces\Dependency\DependencyResolver\setWorkspace().