phpbb\request\type_cast_helper | phpBB API Documentation

class type_cast_helper implements type_cast_helper_interface

A helper class that provides convenience methods for type casting.

Methods

set_var(mixed $result, mixed $var, mixed $type, bool $multibyte = false, bool $trim = true)

Set variable $result to a particular type.

recursive_set_var(string $var, mixed $default, bool $multibyte, bool $trim = true)

Recursively sets a variable to a given type using set_var set_var

Set variable $result to a particular type.

mixed	$result	The variable to fill
mixed	$var	The contents to fill with
mixed	$type	The variable type. Will be used with settype()
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.
bool	$trim	Indicates whether trim() should be applied to string values. Default is true.

Recursively sets a variable to a given type using set_var set_var

string	$var	The value which shall be sanitised (passed by reference).
mixed	$default	Specifies the type $var shall have. If it is an array and $var is not one, then an empty array is returned. Otherwise var is cast to the same type, and if $default is an array all keys and values are cast recursively using this function too.
bool	$multibyte	Indicates whether string keys and values may contain UTF-8 characters. Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks.
bool	$trim	Indicates whether trim() should be applied to string values. Default is true.