ModelHooks module

BatchAction

BatchAction Entity

A model in the Hooks module, with 14 members for templates, 11 API properties and 18 members for admin templates.

Hooks\Models\Frontend\BatchAction Hooks\Models\Api\BatchAction Hooks\Models\Backend\BatchAction Also in Hooks: AgentAction Batch Category Condition ConditionElse ConditionIf CreateFileAction CreateRecordAction DeleteRecordAction EntityBatchEvent EntityEvent Hook HttpRequestAction HttpResponseAction Loop LoopElement MergeFilesAction MergeToPDFAction RenderTemplateAction RetrieveRecordsAction ScheduledBatchEvent SendMailAction SourceHookBatchEvent StopAction TriggerHookAction UpdateRecordAction WebBatchEvent WebEvent
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 14

Take no arguments.

# getVariables()
array
Get the current variables in the scope of the BatchAction
# getId()
?int
# getStatus()
?string
# getData()
?array
# getOutput()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getBatch()
?Batch
# getAction()
?BaseAction
# getChildLoopElements()
?Collection<LoopElement>
# getParentLoopElement()
?LoopElement
# 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 11

Read-only values on the record.

# variables
array
Get the current variables in the scope of the BatchAction
# id
?int
# status
?string
# data
?array
# output
?array
# created
?DateTime
# modified
?DateTime
# batch
?Batch
# action
?BaseAction
# childLoopElements
?Collection<LoopElement>
# parentLoopElement
?LoopElement

Admin view

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

Properties 18

Take no arguments.

# getVariables()
array
Get the current variables in the scope of the BatchAction
# getId()
?int
# getStatus()
?string
# getData()
?array
# getOutput()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getBatch()
?Batch
# getAction()
?BaseAction
# getChildLoopElements()
?Collection<LoopElement>
# getParentLoopElement()
?LoopElement
# 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
# getBatchId() Admin only
int
Get the batch ID
# getActionName() Admin only
string
Get the action name
# getOutputDisplay() Admin only
string
Get the output display for the batch action