ModelHooks module

Loop

Loop Entity

A model in the Hooks module, with 29 members for templates, 26 API properties and 42 members for admin templates.

Hooks\Models\Frontend\Loop Hooks\Models\Api\Loop Hooks\Models\Backend\Loop Also in Hooks: AgentAction Batch BatchAction Category Condition ConditionElse ConditionIf CreateFileAction CreateRecordAction DeleteRecordAction EntityBatchEvent EntityEvent Hook HttpRequestAction HttpResponseAction LoopElement MergeFilesAction MergeToPDFAction RenderTemplateAction RetrieveRecordsAction ScheduledBatchEvent SendMailAction SourceHookBatchEvent StopAction TriggerHookAction UpdateRecordAction WebBatchEvent WebEvent

Templates view

Properties 29

Take no arguments.

# getParent(): ?BaseAction; Validate that the loop is a root level element
# getChildren(): Collection<BaseAction>
# getProcessingType(): string; Set the processing type for this loop
# getRetries(): int; Determines how often failed loop elements should be rescheduled for retries
# getWaitSetting(): string; Get the wait setting for this loop
# isStoppedOnError(): bool; Get whether processing loop elements should be stopped on an error
# getSource(): ?string; Get the source for the loop
# getPropertyPath(): string; Get the propertyPath to use in a WebEvent or Action source
# getTemplateCode(): string; Get the templateCode used to generate loop elements
# getSourceAction(): ?BaseAction; Get the source action for the loop
# getSiteDataKey(): string; Get the siteData key to use when fetch loop elements from site data
# getType(): string; Get the type of the action, which is the object name without namespace for the action
# getDisplayType(): string; Get Nice Name for Action Class
# getAvailablePreviousActions(): Collection; Get the available previous actions
# getId(): ?int
# getName(): ?string
# getText(): ?string
# getPosition(): ?int
# getData(): ?array
# getCreated(): ?DateTime
# getModified(): ?DateTime
# getHook(): ?Hook; Get the Hook this Action is assigned to
# getPublished(): ?DateTime
# isPublished(): bool
# isContainedInLoop(): bool; Check whether the action is contained in a loop
# getContainingLoop(): ?Loop; Get the loop this action is contained in
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 26

Read-only values on the record.

# parent: ?BaseAction; Validate that the loop is a root level element
# children: Collection<BaseAction>
# processingType: string; Set the processing type for this loop
# retries: int; Determines how often failed loop elements should be rescheduled for retries
# waitSetting: string; Get the wait setting for this loop
# stoppedOnError: bool; Get whether processing loop elements should be stopped on an error
# source: ?string; Get the source for the loop
# propertyPath: string; Get the propertyPath to use in a WebEvent or Action source
# templateCode: string; Get the templateCode used to generate loop elements
# sourceAction: ?BaseAction; Get the source action for the loop
# siteDataKey: string; Get the siteData key to use when fetch loop elements from site data
# type: string; Get the type of the action, which is the object name without namespace for the action
# displayType: string; Get Nice Name for Action Class
# availablePreviousActions: Collection; Get the available previous actions
# id: ?int
# name: ?string
# text: ?string
# position: ?int
# data: ?array
# created: ?DateTime
# modified: ?DateTime
# hook: ?Hook; Get the Hook this Action is assigned to
# published: ?DateTime
# published: bool
# containedInLoop: bool; Check whether the action is contained in a loop
# containingLoop: ?Loop; Get the loop this action is contained in

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 42