ElementEntityProcessor
Processor having generic callback methods for element entities
Table of Contents
Properties
- $dataHandler : DataHandler|null
- $workspace : int
Methods
- createClearDependentElementChildReferenceCallback() : string|null
- Callback to determine whether a new child reference shall be considered in the dependency resolver utility.
- createClearDependentElementParentReferenceCallback() : string|null
- Callback to determine whether a new parent reference shall be considered in the dependency resolver utility.
- createNewDependentElementCallback() : mixed
- Callback to add additional data to new elements created in the dependency resolver utility.
- createNewDependentElementChildReferenceCallback() : string|null
- Callback to determine whether a new child reference shall be considered in the dependency resolver utility.
- createNewDependentElementParentReferenceCallback() : string|null
- Callback to determine whether a new parent reference shall be considered in the dependency resolver utility.
- getDataHandler() : DataHandler
- getWorkspace() : int
- Gets the current workspace.
- setWorkspace() : mixed
- Sets the current workspace.
- transformDependentElementsToUseLiveId() : array<string|int, mixed>
- Transforms dependent elements to use the liveId as array key.
Properties
$dataHandler
protected
DataHandler|null
$dataHandler
$workspace
protected
int
$workspace
Methods
createClearDependentElementChildReferenceCallback()
Callback to determine whether a new child reference shall be considered in the dependency resolver utility.
public
createClearDependentElementChildReferenceCallback(array<string|int, mixed> $callerArguments, array<string|int, mixed> $targetArgument, ElementEntity $caller, string $eventName) : string|null
Only elements that are a delete placeholder are considered.
Parameters
- $callerArguments : array<string|int, mixed>
- $targetArgument : array<string|int, mixed>
- $caller : ElementEntity
- $eventName : string
Return values
string|null —Skip response (if required)
createClearDependentElementParentReferenceCallback()
Callback to determine whether a new parent reference shall be considered in the dependency resolver utility.
public
createClearDependentElementParentReferenceCallback(array<string|int, mixed> $callerArguments, array<string|int, mixed> $targetArgument, ElementEntity $caller, string $eventName) : string|null
Only elements that are a delete placeholder are considered.
Parameters
- $callerArguments : array<string|int, mixed>
- $targetArgument : array<string|int, mixed>
- $caller : ElementEntity
- $eventName : string
Return values
string|null —Skip response (if required)
createNewDependentElementCallback()
Callback to add additional data to new elements created in the dependency resolver utility.
public
createNewDependentElementCallback(array<string|int, mixed> $callerArguments, array<string|int, mixed> $targetArgument, ElementEntity $caller, string $eventName) : mixed
Parameters
- $callerArguments : array<string|int, mixed>
- $targetArgument : array<string|int, mixed>
- $caller : ElementEntity
- $eventName : string
Tags
createNewDependentElementChildReferenceCallback()
Callback to determine whether a new child reference shall be considered in the dependency resolver utility.
public
createNewDependentElementChildReferenceCallback(array<string|int, mixed> $callerArguments, array<string|int, mixed> $targetArgument, ElementEntity $caller, string $eventName) : string|null
Parameters
- $callerArguments : array<string|int, mixed>
- $targetArgument : array<string|int, mixed>
- $caller : ElementEntity
- $eventName : string
Return values
string|null —Skip response (if required)
createNewDependentElementParentReferenceCallback()
Callback to determine whether a new parent reference shall be considered in the dependency resolver utility.
public
createNewDependentElementParentReferenceCallback(array<string|int, mixed> $callerArguments, array<string|int, mixed> $targetArgument, ElementEntity $caller, string $eventName) : string|null
Parameters
- $callerArguments : array<string|int, mixed>
- $targetArgument : array<string|int, mixed>
- $caller : ElementEntity
- $eventName : string
Return values
string|null —Skip response (if required)
getDataHandler()
public
getDataHandler() : DataHandler
Return values
DataHandlergetWorkspace()
Gets the current workspace.
public
getWorkspace() : int
Return values
intsetWorkspace()
Sets the current workspace.
public
setWorkspace(int $workspace) : mixed
Parameters
- $workspace : int
transformDependentElementsToUseLiveId()
Transforms dependent elements to use the liveId as array key.
public
transformDependentElementsToUseLiveId(array<string|int, mixed>|array<string|int, ElementEntity> $elements) : array<string|int, mixed>
Parameters
- $elements : array<string|int, mixed>|array<string|int, ElementEntity>