g
Frontend | Backend | Api

Hooks\Models\Frontend\RetrieveRecordsAction

Class for specification of an action to retrieve a record

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 the order that should be applied when retrieving records array
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