Lead extends RecyclableEntity
Table of Contents
Methods
- createRecycleBinEntity() : mixed
- getAdditionalData() : array<string|int, mixed>
- getEntityName() : mixed
- getNotifyMessages() : array<string|int, mixed>
- Get message array for Recycle Bin action's notification
- moveFromRecyclebin() : bool
- Recover entity from Recycle Bin.
- prepareSurveyInfo() : mixed
- previewFromRecyclebin() : bool|void
- Prepare entity view.
- removeFromRecyclebin() : Result
- Erase entity from Recycle Bin.
Methods
createRecycleBinEntity()
public
static createRecycleBinEntity(mixed $entityID) : mixed
Parameters
- $entityID : mixed
getAdditionalData()
public
static getAdditionalData() : array<string|int, mixed>
Return values
array<string|int, mixed>getEntityName()
public
static getEntityName() : mixed
getNotifyMessages()
Get message array for Recycle Bin action's notification
public
static getNotifyMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>moveFromRecyclebin()
Recover entity from Recycle Bin.
public
static moveFromRecyclebin(Entity $entity) : bool
Parameters
- $entity : Entity
Tags
Return values
boolprepareSurveyInfo()
public
static prepareSurveyInfo() : mixed
previewFromRecyclebin()
Prepare entity view.
public
static previewFromRecyclebin(Entity $entity) : bool|void
Parameters
- $entity : Entity
Tags
Return values
bool|voidremoveFromRecyclebin()
Erase entity from Recycle Bin.
public
static removeFromRecyclebin(Entity $entity[, array<string|int, mixed> $params = [] ]) : Result
Parameters
- $entity : Entity
- $params : array<string|int, mixed> = []