class Parameters implements Countable, IteratorAggregate

Parameters.

Properties

protected array $parameters Parameters.

Methods

__construct(array $parameters = [])

Constructor.

int
count()

Returns the numner of items in the collection.

getIterator()

Retruns an array iterator object.

add(string $name, mixed $value)

Adds a parameter.

bool
has(string $name)

Returns TRUE if the parameter exists and FALSE if not.

mixed
get(string $name, mixed $default = null)

Gets a parameter value.

remove(string $name)

Removes a parameter.

array
all()

Returns all the parameters.

array
whitelisted(array $keys, array $defaults = [])

Returns request data where keys not in the whitelist have been removed.

array
blacklisted(array $keys, array $defaults = [])

Returns request data where keys in the blacklist have been removed.

Details

at line 37
__construct(array $parameters = [])

Constructor.

Parameters

array $parameters Parameters

at line 47
int count()

Returns the numner of items in the collection.

Return Value

int

at line 57
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

at line 68
add(string $name, mixed $value)

Adds a parameter.

Parameters

string $name Parameter name
mixed $value Parameter value

at line 79
bool has(string $name)

Returns TRUE if the parameter exists and FALSE if not.

Parameters

string $name Parameter name

Return Value

bool

at line 91
mixed get(string $name, mixed $default = null)

Gets a parameter value.

Parameters

string $name Parameter name
mixed $default Default value

Return Value

mixed

at line 101
remove(string $name)

Removes a parameter.

Parameters

string $name Parameter name

at line 111
array all()

Returns all the parameters.

Return Value

array

at line 123
array whitelisted(array $keys, array $defaults = [])

Returns request data where keys not in the whitelist have been removed.

Parameters

array $keys Keys to whitelist
array $defaults Default values

Return Value

array

at line 135
array blacklisted(array $keys, array $defaults = [])

Returns request data where keys in the blacklist have been removed.

Parameters

array $keys Keys to whitelist
array $defaults Default values

Return Value

array