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

Class DeleteHandler handles the delete action.

It provides a setEnvironment method which has to be used to initialize the environment instead.

 Methods

Delete an model.

delete(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId) : void

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

The model id.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Exception\EditOnlyModeException If the data definition is in edit only mode.
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Exception\NotDeletableException If the data definition does not allow delete actions.
\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException If the model is not found.

{@inheritdoc}

process() 

Delete all children.

deleteChildren() : void

Fetch the model.

fetchModel(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId) : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

The model id.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException If no model are found.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Check if is it allowed to delete a record.

guardIsDeletable(\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface $modelId, bool $redirect) : void

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelIdInterface

The model id.

$redirect

bool

If true it redirects to error page instead of throwing an exception.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Exception\NotDeletableException If deletion is disabled.