Class Input - list of methods

Joomla! Input Base Class
This is an abstracted input class used to manage retrieving data from the application environment.

Direct known subclasses

Cli

Files

Json

Package: Joomla\CMS\Input

License: GNU General Public License version 2 or later; see LICENSE.txt

Located at: Joomla/Input/Input.php

Project: Joomla

Method Summary

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

Constructor.

Parameters

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

Since

1.7.0

Deprecated

Show source code of this method: __construct Source Code

public \Joomla\Input\Input
__get
(mixed $name)

Magic method to get an input object

Parameters

mixed $name Name of the input object to retrieve.

Returns

\Joomla\Input\Input The request input object

Since

1.7.0

Deprecated

Show source code of this method: __get Source Code

public mixed
getArray
(array $vars = array(), mixed $datasource = null, mixed $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 InputFilter::clean.
mixed $datasource Array to retrieve data from, or null.
string $defaultFilter Default filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.

Returns

mixed The filtered input data.

Since

1.7.0

Deprecated

Show source code of this method: getArray Source Code

protected mixed
getArrayRecursive
(array $vars = array(), mixed $datasource = null, mixed $defaultFilter = 'unknown', mixed $recursion = false)

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 InputFilter::clean.
mixed $datasource Array to retrieve data from, or null.
string $defaultFilter Default filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.
bool $recursion Flag to indicate a recursive function call.

Returns

mixed The filtered input data.

Since

3.4.2

Deprecated

Show source code of this method: getArrayRecursive Source Code

public \Joomla\CMS\Input\Input
unserialize
(mixed $input)

Method to unserialize the input.

Parameters

string $input The serialized input.

Returns

\Joomla\CMS\Input\Input The input object.

Since

3.0.0

Deprecated

Show source code of this method: unserialize Source Code

Properties Summary

private static array

$allowedGlobals

Container with allowed superglobals

Since

3.8.9

array

protected \Joomla\CMS\Input\Input[]

$inputs

Input objects

Since

1.7.0

\Joomla\CMS\Input\Input[]

Tags Summary

Since

1.7.0

Deprecated

5.0

Use Joomla\Input\Input instead