g
Frontend | Backend | Api

Hooks\Models\Frontend\WebBatchEvent

Batch event containing information about the web event that issued the hook

Method Description Returns
getType() Get the type of the event causing the hook execution. Always returns 'web' for web events. string
getQueryParameter(string $key) Get the query parameter with the specified key mixed
getHeader(string $key) Get the header with the specified key mixed
getDataDisplay() Get a string representation the source hook and action for this batch event string
getWebEvent() Get the web event that triggered this batch WebEvent
getQueryParameters() Get the query parameters for the called web event array
getPathParameters() Get the path parameters (e.g. everything after the slug, seperated by slash) from the called event array
getHeaders() Get the headers sent with the call to the web event array
getBody() Get the body sent with the call to the web event string
getContentType() Get the content type from the web event call string
getBodyData() Get the body data for this web event call with content-type was application/json. Returns the data in array form if it was submitted as JSON or Form encoded. ReadOnlyCollection
getMethod() Get the HTTP method used when calling the web event string
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