ModelHooks module

LoopElement

A model in the Hooks module, with 16 members for templates, 13 API properties and 17 members for admin templates.

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

Templates view

Properties 16

Take no arguments.

# getRecord(): ?Model; Get the record referenced in the loop element
# isStopped(): bool; Check whether the execution has been stopped
# getRunData(): LoopElementRunData; Get the loop element run data used for exchanging data between batch actions in a loop run, but not persisted to access outside the loop element
# getId(): ?int
# getPosition(): ?int
# getStatus(): ?string
# getOutput(): ?array
# getEntity(): ?string
# getRecordId(): ?int
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getLoopBatchAction(): ?BatchAction
# getChildBatchActions(): Collection<BatchAction>
# 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 13

Read-only values on the record.

# record: ?Model; Get the record referenced in the loop element
# stopped: bool; Check whether the execution has been stopped
# runData: LoopElementRunData; Get the loop element run data used for exchanging data between batch actions in a loop run, but not persisted to access outside the loop element
# id: ?int
# position: ?int
# status: ?string
# output: ?array
# entity: ?string
# recordId: ?int
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# loopBatchAction: ?BatchAction
# childBatchActions: Collection<BatchAction>

Admin view

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

Properties 17