| Method | Description | Returns |
|---|---|---|
| getScheduledEvents() | Get the scheduled events / tasks for this hook | Collection |
| getRecurringEvent() | Get the recurring event for this hook | Task |
| getId() | int | |
| getName() | string | |
| getText() | string | |
| isSynchronous() | bool | |
| getBatchPersistence() | string | |
| getCreated() | DateTime | |
| getModified() | DateTime | |
| getCreatedBy() | User | |
| getModifiedBy() | User | |
| getPublished() | DateTime | |
| isPublished() | bool | |
| getCategory() | Category | |
| getSite() | Site | |
| getBatches() | Collection (Batch) | |
| getActions() | Collection (BaseAction) | |
| getEntityEvents() | Collection (EntityEvent) | |
| getWebEvents() | Collection (WebEvent) | |
| isNewRecord() | Check if the record is a new record | bool |
| isHierarchicalModel() | Check whether a model is a hierarchical model, i.e. can have children | bool |
| isVersionedModel() | Check whether a model is versioned | bool |
| getAvailableEntities() | Get a list of translated entities | array |
| getAvailableBatchPersistenceOptions() | Get the available batch persistence values | array |
| getConfiguredEntities() | Get a list of entities this hook is configured to react on | array |
| getEventsDisplay() | Get a displayable version of the configured events for this hook | string |
| getAvailableWebEventMethods() | Get the event methods to display | array |
| getAvailableActionTypes() | Get the available action types for adding actions | array |
| getActionsCount() | Get the number of actions for this hook. | int |
| getBatchesCount() | Get the number of batches for this hook. | int |
| getHateoasLinks() | Get the HATEOAS links for the record | array |
| getEditUrl() | Get the url for editing the record. | string |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getPublishUrl() | Get the url for publishing the record. | string |
| getManageUrl() | Get the url for managing records. | string |
Hooks\Models\Backend\Hook
Hook