Interface ClipboardInterface

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.

Direct known implementers

DcGeneral\Clipboard\DefaultClipboard

Namespace: DcGeneral\Clipboard
Package: DcGeneral\Clipboard
Located at Clipboard/ClipboardInterface.php

Methods summary
`public mixed`	# `loadFrom( DcGeneral\EnvironmentInterface $objEnvironment )` Load the content of the clipboard from the input provider stored in the environment. Load the content of the clipboard from the input provider stored in the environment. Parameters `$objEnvironment` `DcGeneral\EnvironmentInterface` $objEnvironment The environment where the input provider will retrieve the values from. Returns `mixed`
`public mixed`	# `saveTo( DcGeneral\EnvironmentInterface $objEnvironment )` Save the content of the clipboard to the input provider stored in the environment. Save the content of the clipboard to the input provider stored in the environment. Parameters `$objEnvironment` `DcGeneral\EnvironmentInterface` $objEnvironment The environment where the input provider will store the values to. Returns `mixed`
`public DcGeneral\Clipboard\ClipboardInterface`	# `clear( )` Clear the content of the clipboard. Clear the content of the clipboard. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public boolean`	# `isEmpty( )` Determine if the clipboard is empty. Determine if the clipboard is empty. Returns `boolean`
`public boolean`	# `isNotEmpty( )` Determine if the clipboard is not empty. Determine if the clipboard is not empty. Returns `boolean`
`public boolean`	# `isCut( )` Determine if the content in the clipboard shall be cut. Determine if the content in the clipboard shall be cut. Returns `boolean`
`public boolean`	# `isCopy( )` Determine if the content in the clipboard shall be copied. Determine if the content in the clipboard shall be copied. Returns `boolean`
`public boolean`	# `isCreate( )` Determine if the content in the clipboard is a new item to be created. Determine if the content in the clipboard is a new item to be created. Returns `boolean`
`public DcGeneral\Clipboard\ClipboardInterface`	# `copy( array\|mixed $ids )` Set the clipboard to copy mode and copy the given ids. Set the clipboard to copy mode and copy the given ids. Parameters `$ids` `array\|mixed` $ids The id or ids to be copied. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public DcGeneral\Clipboard\ClipboardInterface`	# `cut( array\|mixed $ids )` Set the clipboard to cut mode and cut the given ids. Set the clipboard to cut mode and cut the given ids. Parameters `$ids` `array\|mixed` $ids The id or ids to be cut. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public DcGeneral\Clipboard\ClipboardInterface`	# `create( mixed $parentId )` Set the clipboard to create mode for a child of the given parent data set. Set the clipboard to create mode for a child of the given parent data set. Parameters `$parentId` `mixed` $parentId The id of the parent data set. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public DcGeneral\Clipboard\ClipboardInterface`	# `setContainedIds( array $arrIds )` Set the ids contained in the clipboard. Set the ids contained in the clipboard. Parameters `$arrIds` `array` $arrIds The list of ids. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public array`	# `getContainedIds( )` Retrieve the ids contained in the clipboard. Retrieve the ids contained in the clipboard. Returns `array`
`public DcGeneral\Clipboard\ClipboardInterface`	# `setCircularIds( array $arrIds )` Set the ids ignored in the clipboard as they would create a circular reference when pasting. Set the ids ignored in the clipboard as they would create a circular reference when pasting. Parameters `$arrIds` `array` $arrIds The list of ids. Returns `DcGeneral\Clipboard\ClipboardInterface`
`public array`	# `getCircularIds( )` Retrieve the ids ignored in the clipboard as they would create a circular reference when pasting. Retrieve the ids ignored in the clipboard as they would create a circular reference when pasting. Returns `array`
`public string`	# `getMode( )` Retrieve the current mode of the clipboard. Retrieve the current mode of the clipboard. Returns `string` Either cut\|paste\|mode

Constants summary
`string`	`MODE_COPY`	`'copy'`	# Clipboard is in copy mode. Clipboard is in copy mode.
`string`	`MODE_CUT`	`'cut'`	# Clipboard is in cut mode. Clipboard is in cut mode.
`string`	`MODE_CREATE`	`'create'`	# Clipboard is in create mode. Clipboard is in create mode.

Namespaces

Classes

Interfaces

Interface ClipboardInterface

Direct known implementers

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns