Documentation

onWriteAction extends wrapper
in package

Importing the `response` class from the `http` namespace.

Table of Contents

$url_pattern  : string|null
A property that is used to filter the events.
onBeforeSend()  : void
Used to build the result.
onCache()  : void
A method that is called when the event `EVENT_BUILD_CACHE` is triggered.
onCheck()  : self
Used to check if the event should be executed.
onComplete()  : void
Used to execute code when the headers are received.
onContext()  : void
A method that is called when the event `EVENT_BUILD_CONTEXT` is triggered.
onException()  : void
Used to execute code when an exception is thrown.
onFinal()  : void
Used to execute code when the request is completed.
onHeaders()  : void
A method that is called when the event `EVENT_BUILD_HEADERS` is triggered.
onIncludes()  : void
A method that is called when the event `EVENT_BUILD_INCLUDES` is triggered.
onRequest()  : void
A method that is called when the event `EVENT_BUILD_REQUEST` is triggered.
onSend()  : void
Used to execute code when the request is sent.
onSent()  : void
Used to execute code before the request is sent.
onWrite()  : void
It checks if the response is not empty and if the MIME type is HTML, JavaScript, CSS, XML, text or HTML. If it is, it will cache the response
subscribe()  : void
Subscribing to all the events.
route()  : void
A method that is used to route the events to the appropriate methods.

Properties

$url_pattern

A property that is used to filter the events.

protected string|null $url_pattern = null

Methods

onBeforeSend()

Used to build the result.

public onBeforeSend() : void
Return values
void

onCache()

A method that is called when the event `EVENT_BUILD_CACHE` is triggered.

public onCache() : void
Return values
void

onCheck()

Used to check if the event should be executed.

public onCheck() : self
Return values
self

onComplete()

Used to execute code when the headers are received.

public onComplete() : void
Return values
void

onContext()

A method that is called when the event `EVENT_BUILD_CONTEXT` is triggered.

public onContext() : void
Return values
void

onException()

Used to execute code when an exception is thrown.

public onException(Exception $e) : void
Parameters
$e : Exception
Return values
void

onFinal()

Used to execute code when the request is completed.

public onFinal() : void
Return values
void

onHeaders()

A method that is called when the event `EVENT_BUILD_HEADERS` is triggered.

public onHeaders() : void
Return values
void

onIncludes()

A method that is called when the event `EVENT_BUILD_INCLUDES` is triggered.

public onIncludes() : void
Return values
void

onRequest()

A method that is called when the event `EVENT_BUILD_REQUEST` is triggered.

public onRequest() : void
Return values
void

onSend()

Used to execute code when the request is sent.

public onSend() : void
Return values
void

onSent()

Used to execute code before the request is sent.

public onSent() : void
Return values
void

onWrite()

It checks if the response is not empty and if the MIME type is HTML, JavaScript, CSS, XML, text or HTML. If it is, it will cache the response

public onWrite() : void
Return values
void

subscribe()

Subscribing to all the events.

public final subscribe(yP $dispatcher) : void
Parameters
$dispatcher : yP
Return values
void

route()

A method that is used to route the events to the appropriate methods.

private route(string $event_name) : void
Parameters
$event_name : string
Return values
void

Search results