| Method | Description | Returns |
|---|---|---|
| getParent() | Validate that the loop is a root level element | BaseAction |
| getChildren() | Collection (BaseAction) | |
| getProcessingType() | Set the processing type for this loop | string |
| getRetries() | Determines how often failed loop elements should be rescheduled for retries | int |
| getWaitSetting() | Get the wait setting for this loop | string |
| isStoppedOnError() | Get whether processing loop elements should be stopped on an error | bool |
| getSource() | Get the source for the loop. If a RetrieveRecord action exists in the loop, default to this. | string |
| getPropertyPath() | Get the propertyPath to use in a WebEvent or Action source | string |
| getTemplateCode() | Get the templateCode used to generate loop elements | string |
| getSourceAction() | Get the source action for the loop. If a RetrieveRecord action exists in the loop, default to this. | BaseAction |
| 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 | |
| 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 |
| getAvailableProcessingTypes() | Get the available processing types | array |
| getAvailableWaitSettings() | Get the available wait settings | array |
| getAvailableSources() | Get the available wait settings | array |
| getAvailableSourceActions() | Get the source actions available to be used in this loop | Collection |
| getDisplayIcon() | Get the display icon to use when rendering the action | string |
| getAllChildActions() | Get all children for the loop | Collection |
| getAvailableTemplateVariables() | Get the available template variables for this loop | array |
| getMaxRetries() | Get the maximum number of allowed retries for a loop element | int |
| 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 |
Hooks\Models\Backend\Loop
Loop Entity