Skip to content

Latest commit

 

History

History
450 lines (149 loc) · 3.38 KB

streamPluginAction.md

File metadata and controls

450 lines (149 loc) · 3.38 KB

streamPluginAction

Extending the wrapper class, which is a class that allows you to listen to events.

Properties

output_buffer_types

An array of content types that will be streamed.

private array $output_buffer_types

stream

A variable that is used to determine if the response should be streamed or not.

private bool $stream

max_content_length

Used to determine if the response should be streamed or not.

private int $max_content_length

Methods

onSent

Checking if the content type is in the array of content types that should be streamed. If it is, it sets the $stream variable to true.

public onSent(): void

onWrite

A function that is called when the proxy receives data from the server.

public onWrite(): void

onComplete

Used to exit the script when the response is streamed.

public onComplete(): void

Inherited methods

subscribe

Subscribing to all the events.

final public subscribe(\yxorP\lib\yP $dispatcher): void
  • This method is final.

Parameters:

Parameter Type Description
$dispatcher \yxorP\lib\yP

route

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

private route(string $event_name): void

Parameters:

Parameter Type Description
$event_name string

onCache

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

public onCache(): void

onCheck

Used to check if the event should be executed.

public onCheck(): self

onContext

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

public onContext(): void

onIncludes

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

public onIncludes(): void

onHeaders

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

public onHeaders(): void

onRequest

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

public onRequest(): void

onBeforeSend

Used to build the result.

public onBeforeSend(): void

onSend

Used to execute code when the request is sent.

public onSend(): void

onSent

Used to execute code before the request is sent.

public onSent(): void

onWrite

Used to execute code when the headers are received.

public onWrite(): void

onComplete

Used to execute code when the headers are received.

public onComplete(): void

onFinal

Used to execute code when the request is completed.

public onFinal(): void

onException

Used to execute code when an exception is thrown.

public onException(\Exception $e): void

Parameters:

Parameter Type Description
$e \Exception