g
Frontend | Backend | Api

Hooks\Models\Frontend\Batch

Batch Entity

Method Description Returns
isInterrupted() Check whether the batch execution should be interrupted bool
getFolderPath() Get the folder to use when working with files (in the files module) for this batch string
isStopped() Check whether the execution has been stopped bool
getId() int
getStatus() string
getCustomData() array
getBatchEvent() BatchEvent
getCreated() DateTime
getModified() DateTime
getSite() Site
getHook() Hook
getBatchActions() Collection
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