Task implements Recyclebinable
Table of Contents
Interfaces
Methods
- getAdditionalData() : array<string|int, mixed>
- getDeleteMessage() : string
- getNotifyMessages() : array<string|int, mixed>
- isInTheRecycleBin() : array<string|int, mixed>
- Checks if tasks are in the recycle bin.
- moveFromRecyclebin() : bool
- OnBeforeTaskDelete() : mixed
- previewFromRecyclebin() : void
- removeFromRecyclebin() : bool
- Removes entity from recycle bin
Methods
getAdditionalData()
public
static getAdditionalData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDeleteMessage()
public
static getDeleteMessage([int $userId = 0 ]) : string
Parameters
- $userId : int = 0
Return values
stringgetNotifyMessages()
public
static getNotifyMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —[ 'NOTIFY'=> [ 'RESTORE' => Loc::getMessage(''), 'REMOVE' => Loc::getMessage(''), ], 'CONFIRM' => [ 'RESTORE' => Loc::getMessage(''), 'REMOVE' => Loc::getMessage('') ]
isInTheRecycleBin()
Checks if tasks are in the recycle bin.
public
static isInTheRecycleBin(array<string|int, mixed> $taskIds) : array<string|int, mixed>
Parameters
- $taskIds : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>moveFromRecyclebin()
public
static moveFromRecyclebin(Entity $entity) : bool
Parameters
- $entity : Entity
Return values
boolOnBeforeTaskDelete()
public
static OnBeforeTaskDelete(int $taskId[, array<string|int, mixed> $task = [] ]) : mixed
Parameters
- $taskId : int
- $task : array<string|int, mixed> = []
Tags
previewFromRecyclebin()
public
static previewFromRecyclebin(Entity $entity) : void
and will be removed since recyclebin 23.0.0
Parameters
- $entity : Entity
Tags
removeFromRecyclebin()
Removes entity from recycle bin
public
static removeFromRecyclebin(Entity $entity[, array<string|int, mixed> $params = [] ]) : bool
Parameters
- $entity : Entity
- $params : array<string|int, mixed> = []