final class Request

Presenter request.

Constants

FORWARD

method

RESTORED

flag

VARYING

flag

Methods

__construct(string $name, string|null $method = null, array $params = [], array $post = [], array $files = [], array $flags = [])

No description

setPresenterName(string $name)

Sets the presenter name.

string
getPresenterName()

Retrieve the presenter name.

setParameters(array $params)

Sets variables provided to the presenter.

array
getParameters()

Returns all variables provided to the presenter (usually via URL).

mixed
getParameter(string $key)

Returns a parameter provided to the presenter.

setPost(array $params)

Sets variables provided to the presenter via POST.

mixed
getPost(string|null $key = null)

Returns a variable provided to the presenter via POST.

setFiles(array $files)

Sets all uploaded files.

array
getFiles()

Returns all uploaded files.

setMethod(string|null $method)

Sets the method.

string|null
getMethod()

Returns the method.

bool
isMethod(string $method)

Checks if the method is the given one.

setFlag(string $flag, bool $value = true)

Sets the flag.

bool
hasFlag(string $flag)

Checks the flag.

array
toArray()

No description

Details

at line 41
__construct(string $name, string|null $method = null, array $params = [], array $post = [], array $files = [], array $flags = [])

No description

Parameters

string $name

presenter name (module:module:presenter)

string|null $method
array $params
array $post
array $files
array $flags

at line 55
Request setPresenterName(string $name)

Sets the presenter name.

Parameters

string $name

Return Value

Request

at line 65
string getPresenterName()

Retrieve the presenter name.

Return Value

string

at line 74
Request setParameters(array $params)

Sets variables provided to the presenter.

Parameters

array $params

Return Value

Request

at line 84
array getParameters()

Returns all variables provided to the presenter (usually via URL).

Return Value

array

at line 93
mixed getParameter(string $key)

Returns a parameter provided to the presenter.

Parameters

string $key

Return Value

mixed

at line 102
Request setPost(array $params)

Sets variables provided to the presenter via POST.

Parameters

array $params

Return Value

Request

at line 113
mixed getPost(string|null $key = null)

Returns a variable provided to the presenter via POST.

If no key is passed, returns the entire array.

Parameters

string|null $key

Return Value

mixed

at line 124
Request setFiles(array $files)

Sets all uploaded files.

Parameters

array $files

Return Value

Request

at line 134
array getFiles()

Returns all uploaded files.

Return Value

array

at line 143
Request setMethod(string|null $method)

Sets the method.

Parameters

string|null $method

Return Value

Request

at line 153
string|null getMethod()

Returns the method.

Return Value

string|null

at line 162
bool isMethod(string $method)

Checks if the method is the given one.

Parameters

string $method

Return Value

bool

at line 171
Request setFlag(string $flag, bool $value = true)

Sets the flag.

Parameters

string $flag
bool $value

Return Value

Request

at line 181
bool hasFlag(string $flag)

Checks the flag.

Parameters

string $flag

Return Value

bool

at line 187
array toArray()

No description

Return Value

array

Traits

SmartObject