Documentation

Request
in package

GLobal request data

Table of Contents

$globalRouter  : Router|null
Global router
getChecked()  : mixed
Method hashes checkbox state
getParam()  : mixed
Method returns request parameter
getParamAsString()  : string
Method returns request parameter as string
getRouter()  : Router
Method returns router
registerRouter()  : void
Method registers router
wasSubmitted()  : bool
Was the parameter submitted
getSessionIdFromHeaders()  : string
Fetching auth token from headers

Properties

$globalRouter

Global router

private static Router|null $globalRouter = null

Methods

getChecked()

Method hashes checkbox state

public static getChecked(string $fieldName, array<string|int, mixed> $vars) : mixed
Parameters
$fieldName : string

field name

$vars : array<string|int, mixed>

check box values

Return values
mixed

hash item

getParam()

Method returns request parameter

public static getParam(string $param[, mixed $default = false ]) : mixed
Parameters
$param : string

parameter name

$default : mixed = false

default value

Tags
psalm-suppress

MixedAssignment

codeCoverageIgnore
Return values
mixed

parameter value

getParamAsString()

Method returns request parameter as string

public static getParamAsString(string $param[, mixed $default = false ]) : string
Parameters
$param : string

parameter name

$default : mixed = false

default value

Return values
string

parameter value

getRouter()

Method returns router

public static getRouter() : Router
Return values
Router

router

registerRouter()

Method registers router

public static registerRouter(Router|null $router) : void
Parameters
$router : Router|null

router

Return values
void

wasSubmitted()

Was the parameter submitted

public static wasSubmitted(string $param) : bool
Parameters
$param : string

parameter name

Return values
bool

true if the parameter was submitted, false otherwise

getSessionIdFromHeaders()

Fetching auth token from headers

protected static getSessionIdFromHeaders(array<string|int, string> $headers) : string
Parameters
$headers : array<string|int, string>

request headers

Return values
string

session id

Search results