interface request_interface

An interface through which all application input can be accessed.

Constants

POST

GET

REQUEST

COOKIE

SERVER

FILES

Methods

overwrite(string $var_name, mixed $value, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

This function allows overwriting or setting a value in one of the super global arrays.

mixed
variable(string|array $var_name, mixed $default, bool $multibyte = false, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Central type safe input handling function.

mixed
server(string|array $var_name, mixed $default = '')

Shortcut method to retrieve SERVER variables.

mixed
header($var_name, $default = '')

Shortcut method to retrieve the value of client HTTP headers.

bool
is_set_post(string $name)

Checks whether a certain variable was sent via POST.

bool
is_set(string $var, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Checks whether a certain variable is set in one of the super global arrays.

bool
is_ajax()

Checks whether the current request is an AJAX request (XMLHttpRequest)

bool
is_secure()

Checks if the current request is happening over HTTPS.

array
variable_names(request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Returns all variable names for a given super global

array
get_super_global(request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Returns the original array of the requested super global

string|array
escape(mixed $value, bool $multibyte)

Escape a string variable.

Details

at line 45
overwrite(string $var_name, mixed $value, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

This function allows overwriting or setting a value in one of the super global arrays.

Changes which are performed on the super globals directly will not have any effect on the results of other methods this class provides. Using this function should be avoided if possible! It will consume twice the the amount of memory of the value

Parameters

string $var_name The name of the variable that shall be overwritten
mixed $value The value which the variable shall contain. If this is null the variable will be unset.
request_interface::POST|GET|REQUEST|COOKIE $super_global Specifies which super global shall be changed

at line 65
mixed variable(string|array $var_name, mixed $default, bool $multibyte = false, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Central type safe input handling function.

All variables in GET or POST requests should be retrieved through this function to maximise security.

Parameters

string|array $var_name The form variable's name from which data shall be retrieved. If the value is an array this may be an array of indizes which will give direct access to a value at any depth. E.g. if the value of "var" is array(1 => "a") then specifying array("var", 1) as the name will return "a".
mixed $default A default value that is returned if the variable was not set. This function will always return a value of the same type as the default.
bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
request_interface::POST|GET|REQUEST|COOKIE $super_global Specifies which super global should be used

Return Value

mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the the same as that of $default. If the variable is not set $default is returned.

at line 75
mixed server(string|array $var_name, mixed $default = '')

Shortcut method to retrieve SERVER variables.

Parameters

string|array $var_name See \phpbb\request\request_interface::variable
mixed $default See \phpbb\request\request_interface::variable

Return Value

mixed The server variable value.

at line 85
mixed header($var_name, $default = '')

Shortcut method to retrieve the value of client HTTP headers.

Parameters

$var_name
$default

Return Value

mixed The header value.

at line 97
bool is_set_post(string $name)

Checks whether a certain variable was sent via POST.

To make sure that a request was sent using POST you should call this function on at least one variable.

Parameters

string $name The name of the form variable which should have a _p suffix to indicate the check in the code that creates the form too.

Return Value

bool True if the variable was set in a POST request, false otherwise.

at line 109
bool is_set(string $var, request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Checks whether a certain variable is set in one of the super global arrays.

Parameters

string $var Name of the variable
request_interface::POST|GET|REQUEST|COOKIE $super_global Specifies the super global which shall be checked

Return Value

bool True if the variable was sent as input

at line 116
bool is_ajax()

Checks whether the current request is an AJAX request (XMLHttpRequest)

Return Value

bool True if the current request is an ajax request

at line 123
bool is_secure()

Checks if the current request is happening over HTTPS.

Return Value

bool True if the request is secure.

at line 134
array variable_names(request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Returns all variable names for a given super global

Parameters

request_interface::POST|GET|REQUEST|COOKIE $super_global The super global from which names shall be taken

Return Value

array All variable names that are set for the super global. Pay attention when using these, they are unsanitised!

at line 144
array get_super_global(request_interface::POST|GET|REQUEST|COOKIE $super_global = \phpbb\request\request_interface::REQUEST)

Returns the original array of the requested super global

Parameters

request_interface::POST|GET|REQUEST|COOKIE $super_global The super global which will be returned

Return Value

array The original array of the requested super global.

at line 154
string|array escape(mixed $value, bool $multibyte)

Escape a string variable.

Parameters

mixed $value The contents to fill with
bool $multibyte Indicates whether string values may contain UTF-8 characters. Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks.

Return Value

string|array