Frontend | Backend | Api

Hooks\Models\Backend\StopAction

StopAction Entity

Method Description Returns
getTargetStatus() Get the status the batch or loop element should have after this action is executed string
isCleanUpEnforced() Check whether a clean-up of the batch is enforced through the stop action bool
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
getAvailableTargetStatuses() Get the available statuses 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