Class DefaultClipboard

Class DefaultClipboard.

Default implementation of the clipboard.

DcGeneral\Clipboard\DefaultClipboard implements DcGeneral\Clipboard\ClipboardInterface

Namespace: DcGeneral\Clipboard
Package: DcGeneral\Clipboard
Located at Clipboard/DefaultClipboard.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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::loadFrom()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::saveTo()`
`public DcGeneral\Clipboard\ClipboardInterface`	# `clear( )` Clear the content of the clipboard. Clear the content of the clipboard. Returns `DcGeneral\Clipboard\ClipboardInterface` Implementation of `DcGeneral\Clipboard\ClipboardInterface::clear()`
`public boolean`	# `isEmpty( )` Determine if the clipboard is empty. Determine if the clipboard is empty. Returns `boolean` Implementation of `DcGeneral\Clipboard\ClipboardInterface::isEmpty()`
`public boolean`	# `isNotEmpty( )` Determine if the clipboard is not empty. Determine if the clipboard is not empty. Returns `boolean` Implementation of `DcGeneral\Clipboard\ClipboardInterface::isNotEmpty()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::isCut()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::isCopy()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::isCreate()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::copy()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::cut()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::create()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::setContainedIds()`
`public array`	# `getContainedIds( )` Retrieve the ids contained in the clipboard. Retrieve the ids contained in the clipboard. Returns `array` Implementation of `DcGeneral\Clipboard\ClipboardInterface::getContainedIds()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::setCircularIds()`
`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` Implementation of `DcGeneral\Clipboard\ClipboardInterface::getCircularIds()`
`public string`	# `getMode( )` Retrieve the current mode of the clipboard. Retrieve the current mode of the clipboard. Returns `string` Either cut\|paste\|mode Implementation of `DcGeneral\Clipboard\ClipboardInterface::getMode()`

Constants inherited from DcGeneral\Clipboard\ClipboardInterface
`MODE_COPY, MODE_CREATE, MODE_CUT`

Properties summary
`protected array`	`$arrIds`	# The ids contained. The ids contained.
`protected array`	`$arrCircularIds`	# The ids that will create a circular reference and therefore shall get ignored for pasting. The ids that will create a circular reference and therefore shall get ignored for pasting.
`protected string`	`$mode`	# The current mode the clipboard is in. The current mode the clipboard is in.

Namespaces

Classes

Interfaces

Class DefaultClipboard

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of