| Method | Description | Returns |
|---|---|---|
| getSourceRecord(BatchAction $batchAction) | Get the source record | Model |
| getSource() | Get the source for the update record action | string |
| getSourceAction() | Get the source action for the update record action | BaseAction |
| getElementIndex() | Get the element index if the update record action is using a source requiring an index | int |
| getEntity() | Get the entity to use when selecting a record directly by entity and id | string |
| getRecordId() | Get the record id to use when selecting a record directly by entity and id | string |
| getType() | Get the type of the action, which is the object name without namespace for the action | string |
| getDisplayType() | Get Nice Name for Action Class | string |
| getAvailablePreviousActions() | Get the available previous actions | Collection |
| getId() | int | |
| getName() | string | |
| getText() | string | |
| getPosition() | int | |
| getData() | array | |
| getCreated() | DateTime | |
| getModified() | DateTime | |
| getHook() | Get the Hook this Action is assigned to | Hook |
| getParent() | BaseAction | |
| getPublished() | DateTime | |
| isPublished() | bool | |
| isContainedInLoop() | Check whether the action is contained in a loop | bool |
| getContainingLoop() | Get the loop this action is contained in | Loop |
| 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 |
| getDisplayIcon() | Get the display icon to use when rendering the action | string |
| getRunDataVariables() | Get the run data variables provided by this action | array |
| getHateoasLinks() | Get the HATEOAS links for the record | array |
| getEditUrl() | Get the url for editing the record. | string |
| getMoveUrl() | Get the url for moving the record. | string |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getAvailableSources() | Get the sources available to be used in this action | array |
| getAvailableSourceActions() | Get the source actions available to be used in this action | Collection |
| getAvailableEntities() | Get the available entities for recordId mode | array |
| getAvailableTemplateVariables() | Get the template variables available in this action | array |
Hooks\Models\Backend\DeleteRecordAction
UpdateRecordAction Entity