class Input extends Input

Joomla! Input Base Class

This is an abstracted input class used to manage retrieving data from the application environment.

Methods

__construct( array $source = null, array $options = array())

Constructor.

__get( mixed $name)

Magic method to get an input object

mixed
getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

unserialize( string $input)

Method to unserialize the input.

Details

__construct( array $source = null, array $options = array())

Constructor.

Parameters

array $source Source data (Optional, default is $_REQUEST)
array $options Array of configuration parameters (Optional)

Input __get( mixed $name)

Magic method to get an input object

Parameters

mixed $name Name of the input object to retrieve.

Return Value

Input The request input object

mixed getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

Parameters

array $vars Associative array of keys and filter types to apply. If empty and datasource is null, all the input data will be returned but filtered using the filter given by the parameter defaultFilter in JFilterInput::clean.
mixed $datasource Array to retrieve data from, or null.
string $defaultFilter Default filter used in JFilterInput::clean if vars is empty and datasource is null. If 'unknown', the default case is used in JFilterInput::clean.

Return Value

mixed The filtered input data.

Input unserialize( string $input)

Method to unserialize the input.

Parameters

string $input The serialized input.

Return Value

Input The input object.