class GetParameter implements Rule, Bypass

A rule to match a GET parameter within HTTPRequest

Methods

__construct(string $name)

Initialize the rule with a parameter name

string
getName()

Return the parameter name

$this
setName(string $name)

Set the parameter name

bool
checkRequestForBypass(HTTPRequest $request)

Check the request for whether we can bypass the confirmation

null|Item
getRequestConfirmationItem(HTTPRequest $request)

Check the request by the rule and return a confirmation item

Details

at line 25
__construct(string $name)

Initialize the rule with a parameter name

Parameters

string $name

at line 35
string getName()

Return the parameter name

Return Value

string

at line 47
$this setName(string $name)

Set the parameter name

Parameters

string $name

Return Value

$this

at line 94
bool checkRequestForBypass(HTTPRequest $request)

Check the request for whether we can bypass the confirmation

Parameters

HTTPRequest $request

Return Value

bool True if we can bypass, False if the confirmation is required

at line 99
null|Item getRequestConfirmationItem(HTTPRequest $request)

Check the request by the rule and return a confirmation item

Parameters

HTTPRequest $request

Return Value

null|Item Confirmation item if necessary to protect the request or null otherwise