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

The interface for a view.

 Methods

Endpoint for create operation.

create(\ContaoCommunityAlliance\DcGeneral\Action $action) : string

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Returns

string

Delete a model and redirect the user to the listing.

delete(\ContaoCommunityAlliance\DcGeneral\Action $action) : void
NOTE: This method redirects the user to the listing and therefore the script will be ended.

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Endpoint for edit operation.

edit(\ContaoCommunityAlliance\DcGeneral\Action $action) : string

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Returns

string

Abstract method to be overridden in the certain child classes.

enforceModelRelationship(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : void
This method will update the parent relationship between a model and the parent item.

Parameters

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model to be updated.

Retrieve the attached environment.

getEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Handle an ajax request.

handleAjaxCall() : void

Endpoint for move operation.

move(\ContaoCommunityAlliance\DcGeneral\Action $action) : string

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Returns

string

Invoked for cut and copy - inserts the content of the clipboard at the given position.

paste(\ContaoCommunityAlliance\DcGeneral\Action $action) : void

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Set the environment.

setEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) : \ContaoCommunityAlliance\DcGeneral\View\ViewInterface

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment.

Returns

\ContaoCommunityAlliance\DcGeneral\View\ViewInterface

Overview listing over all items in the current scope.

showAll(\ContaoCommunityAlliance\DcGeneral\Action $action) : string
This is the default action to perform if no other action has been specified in the URL.

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Returns

string

Endpoint for undo operation.

undo(\ContaoCommunityAlliance\DcGeneral\Action $action) : string

Parameters

$action

\ContaoCommunityAlliance\DcGeneral\Action

The action being executed.

Returns

string