Frontend | Backend | Api

Hooks\Models\Frontend\EntityBatchEvent

Batch event containing information about which entity and record triggered a Hook and thus created a Batch

Method Description Returns
getType() Get the type of the event causing the hook execution. Always returns 'entity' for entity events. string
getDataDisplay() Get a string representation of this EntityBatchEvent's record string
getEntityName() string
getMethod() string
getRecordId() int
getRecord() Model
getPreEventData() Get the data stored before the event occurs with the specified properties array
getTypeDisplay() Get a string representation of the batch event based on its type string
getId() int
getCreated() Date the record was created. DateTime
getCreatedBy() Get the user that triggered the event User
getBatch() Batch
isNewRecord() Check if the record is a new record bool
getPropertyValueOrigin(string $property) Get the origin of a property value => how it has been filled string
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool