class GetParameter implements Rule, Bypass (View source)

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

__construct(string $name)

Initialize the rule with a parameter name

Parameters

string $name

string getName()

Return the parameter name

Return Value

string

$this setName(string $name)

Set the parameter name

Parameters

string $name

Return Value

$this

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

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