Request extends Component Uses Context
Handles the request context.
Table of Contents
- $context : array<string|int, mixed>
- Object context values.
- __construct() : mixed
- Class constructor.
- get_context() : mixed
- Gets object context values.
- get_page_number() : int
- Gets the current page number.
- get_param() : mixed
- Gets query parameter.
- get_params() : array<string|int, mixed>
- Gets query parameters.
- get_user() : object
- Gets the current user.
- set_context() : mixed
- Sets object context value.
- set_request_context() : mixed
- Sets the current request context.
- boot() : mixed
- Bootstraps component properties.
- set_callbacks() : mixed
- Sets the action and filter callbacks.
- set_property() : mixed
- Sets a property value.
Properties
$context
Object context values.
protected
array<string|int, mixed>
$context
= []
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Component arguments.
Return values
mixed —get_context()
Gets object context values.
public
final get_context([string $name = null ][, mixed $default = null ]) : mixed
Parameters
- $name : string = null
-
Context name.
- $default : mixed = null
-
Default value.
Return values
mixed —get_page_number()
Gets the current page number.
public
get_page_number() : int
Return values
int —get_param()
Gets query parameter.
public
get_param(string $name) : mixed
Parameters
- $name : string
-
Parameter name.
Return values
mixed —get_params()
Gets query parameters.
public
get_params() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_user()
Gets the current user.
public
get_user() : object
Return values
object —set_context()
Sets object context value.
public
set_context(string $name, mixed $value) : mixed
Parameters
- $name : string
-
Context name.
- $value : mixed
-
Context value.
Return values
mixed —set_request_context()
Sets the current request context.
public
set_request_context() : mixed
Return values
mixed —boot()
Bootstraps component properties.
protected
boot() : mixed
Return values
mixed —set_callbacks()
Sets the action and filter callbacks.
protected
final set_callbacks(array<string|int, mixed> $callbacks) : mixed
Parameters
- $callbacks : array<string|int, mixed>
-
Callback arguments.
Return values
mixed —set_property()
Sets a property value.
protected
final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
- $prefix : string = ''
-
Method prefix.