| Method | Description | Returns |
|---|---|---|
| getType() | Get the type of the event causing the hook execution. Always returns 'hook' for entity events. | string |
| getDataDisplay() | Get a string representation the source hook and action for this batch event | string |
| getSourceBatchAction() | Get the source batch action for this event | BatchAction |
| getSourceBatch() | Get the source batch for this event | Batch |
| getSourceHook() | Get the source hook for this event | Hook |
| getSourceAction() | Get the source action for this event | TriggerHookAction |
| getData() | Get the data passed to this event | array |
| getTypeDisplay() | Get a string representation of the batch event based on its type | string |
| getId() | int | |
| getCreated() | Date the record was created. | DateTime |
| getCreatedBy() | Get the user that triggered the event | User |
| getBatch() | Batch | |
| isNewRecord() | Check if the record is a new record | bool |
| getPropertyValueOrigin(string $property) | Get the origin of a property value => how it has been filled | string |
| isHierarchicalModel() | Check whether a model is a hierarchical model, i.e. can have children | bool |
Hooks\Models\Frontend\SourceHookBatchEvent
Event triggered when a different hooks triggers this hook through a trigger hook action