FileBag

__construct(array $parameters = array())

Parameters

array

$parameters

An array of parameters

array all()

Returns the parameters.

Return Value

array

An array of parameters

array keys()

Returns the parameter keys.

Return Value

array

An array of parameter keys

replace(array $files = array())

Replaces the current parameters by a new set.

Parameters

array

$files

add(array $files = array())

Adds parameters.

Parameters

array

$files

mixed get(string $path, mixed $default = null, bool $deep = false)

Returns a parameter by name.

Parameters

string	$path	The key
mixed	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

mixed

Exceptions

InvalidArgumentException

set(string $key, mixed $value)

Sets a parameter by name.

Parameters

string	$key	The key
mixed	$value	The value

bool has(string $key)

Returns true if the parameter is defined.

Parameters

string

$key

The key

Return Value

bool	true if the parameter exists, false otherwise

remove(string $key)

Removes a parameter.

Parameters

string

$key

The key

string getAlpha(string $key, string $default = '', bool $deep = false)

Returns the alphabetic characters of the parameter value.

Parameters

string	$key	The parameter key
string	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

string

The filtered value

string getAlnum(string $key, string $default = '', bool $deep = false)

Returns the alphabetic characters and digits of the parameter value.

Parameters

string	$key	The parameter key
string	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

string

The filtered value

string getDigits(string $key, string $default = '', bool $deep = false)

Returns the digits of the parameter value.

Parameters

string	$key	The parameter key
string	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

string

The filtered value

int getInt(string $key, int $default, bool $deep = false)

Returns the parameter value converted to integer.

Parameters

string	$key	The parameter key
int	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

int	The filtered value

bool getBoolean(string $key, mixed $default = false, bool $deep = false)

Returns the parameter value converted to boolean.

Parameters

string	$key	The parameter key
mixed	$default	The default value if the parameter key does not exist
bool	$deep	If true, a path like foo[bar] will find deeper items

Return Value

bool	The filtered value

mixed filter(string $key, mixed $default = null, bool $deep = false, int $filter = FILTER_DEFAULT, mixed $options = array())

Filter key.

Parameters

string	$key	Key
mixed	$default	Default = null
bool	$deep	Default = false
int	$filter	FILTER_* constant
mixed	$options	Filter options

Return Value

mixed

See also

http://php.net/manual/en/function.filter-var.php

ArrayIterator getIterator()

Returns an iterator for parameters.

Return Value

ArrayIterator

An \ArrayIterator instance

int count()

Returns the number of parameters.

Return Value

int	The number of parameters