Method | Description | Returns |
---|---|---|
getEntity() | Get the entity which should be retrieved | string |
getCriteria() | Get the criteria that should be passed to the handler when searching for the record | array |
getOrderBy() | Get a string representation of the order by array | string |
getLimit() | Get the limit for retrieving records | string |
getOffset() | Get the offset when retrieving records | 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() | Hook | |
getParent() | BaseAction | |
getContainingLoop() | Get the loop this action is contained in | Loop |
isContainedInLoop() | Check whether the action is contained in a loop | bool |
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 |
getModule() | Get the module name from which records should be retrieved | string |
getEntityName() | Get the entity name (without namespace) from which records should be retrieved | string |
getAvailableEntities() | Get the entities available for retrieving using this action | array |
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 |
getAvailableTemplateVariables() | Get the template variables available in this action | array |
Hooks\Models\Backend\RetrieveRecordsAction
Class for specification of an action to retrieve a record