Interface ClipboardInterface.
This interface describes the internal clipboard of DcGeneral.
The implementing class will store the values persistent to the input provider stored in the environment.
Methods
Clear the complete clipboard.
clear() : static
Retrieve the ids ignored in the clipboard as they would create a circular reference when pasting.
getCircularIds() : array
Retrieve the ids contained in the clipboard.
getContainedIds() : array
Retrieve the current mode of the clipboard.
getMode() : string
Returns
stringEither cut|paste|mode
Retrieve the id of the parent item (if any).
getParent() : null | string
This is only valid in create mode.
Returns
nullstring
Determine if an item exist.
has(\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface $item) : static
Parameters
Returns
static
Determine if an item for the model id exist.
hasId(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId) : static
Parameters
Returns
static
Determine if the content in the clipboard shall be copied.
isCopy() : bool
Determine if the content in the clipboard is a new item to be created.
isCreate() : bool
Determine if the content in the clipboard shall be cut.
isCut() : bool
Determine if the clipboard is empty.
isEmpty(\ContaoCommunityAlliance\DcGeneral\Clipboard\FilterInterface|null $filter) : bool
Determine if the clipboard is not empty.
isNotEmpty(\ContaoCommunityAlliance\DcGeneral\Clipboard\FilterInterface|null $filter) : bool
Load the content of the clipboard from the input provider stored in the environment.
loadFrom(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $objEnvironment) : static
Parameters
Returns
static
Push an item to the clipboard.
push(\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface $item) : static
Parameters
Returns
static
Remove an item from the clipboard.
remove(\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface $item) : static
Parameters
Returns
static
Remove an item from the clipboard.
removeById(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId) : static
Parameters
Returns
static
Save the content of the clipboard to the input provider stored in the environment.
saveTo(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $objEnvironment) : static
Parameters
Returns
static
Constants
Clipboard is in copy mode.
MODE_COPY
Clipboard is in create mode.
MODE_CREATE
Clipboard is in cut mode.
MODE_CUT