contao-community-alliance/dc-general
Back to top  

Interface ItemInterface.

A single clipboard action item.

 Methods

Determine if this item, is equals to the other item.

equals(\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface $item) : bool

Parameters

$item

\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface

The other item.

Returns

bool

Retrieve the current action of the clipboard.

getAction() : string

Returns

stringOne of ItemInterface::CREATE, ItemInterface::CUT, ItemInterface::COPY

Retrieve the id of the model from this item.

getModelId() : \ContaoCommunityAlliance\DcGeneral\Data\ModelId | null

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdnull

Retrieve the id of the parent model from this item.

getParentId() : \ContaoCommunityAlliance\DcGeneral\Data\ModelId | null

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdnull

Determine if the content in the clipboard shall be copied.

isCopy() : bool

Returns

bool

Determine if the content in the clipboard is a new item to be created.

isCreate() : bool

Returns

bool

Determine if the content in the clipboard shall be cut.

isCut() : bool

Returns

bool

Determine if the content in the clipboard shall be copied with all children.

isDeepCopy() : bool

Returns

bool

 Constants

 

Item is in copy action.

COPY 
 

Item is in create action.

CREATE 
 

Item is in cut action.

CUT 
 

Item is in deep copy action.

DEEP_COPY