Référence de la classe Input

Graphe d'héritage de Input:

Fonctions membres publiques
	__construct ($source=null, array $options=[])
	__get ($name)
	count ()
	get ($name, $default=null, $filter='cmd')
	getArray (array $vars=[], $datasource=null)
	getInputForRequestMethod ()
	set ($name, $value)
	def ($name, $value)
	exists ($name)
	__call ($name, $arguments)
	getMethod ()

Attributs protégés
	$options = []
	$filter
	$data = []
	$inputs = []

Attributs privés
const	ALLOWED_GLOBALS = ['REQUEST', 'GET', 'POST', 'FILES', 'SERVER', 'ENV']

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Paramètres

array | null	$source	Optional source data. If omitted, a copy of the server variable '_REQUEST' is used.
array	$options	An optional associative array of configuration parameters: filter: An instance of Filter. If omitted, a default filter is initialised.

Depuis

1.0

Références Input\$options.

Documentation des fonctions membres

__call()

__call	(		$name,
			$arguments
	)

Magic method to get filtered input data.

Paramètres

string	$name	Name of the filter type prefixed with 'get'.
array	$arguments	[0] The name of the variable [1] The default value.

Renvoie

mixed The filtered input value.

Depuis

1.0

Références $default, Input\$filter, $name, et null.

__get()

__get

(

$name

)

Magic method to get an input object

Paramètres

mixed

$name

Name of the input object to retrieve.

Renvoie

Input The request input object

Depuis

1.0

Références $className, $name, Input\$options, et null.

count()

count

(

)

Get the number of variables.

Renvoie

integer The number of variables in the input.

Depuis

1.0

Voir également

Countable::count()

def()

def	(		$name,
			$value
	)

Define a value. The value will only be set if there's no value for the name or if it is null.

Paramètres

string	$name	Name of the value to define.
mixed	$value	Value to assign to the input.

Renvoie

void

Depuis

1.0

Références $name, et $value.

exists()

exists

(

$name

)

Check if a value name exists.

Paramètres

string

$name

Value name

Renvoie

boolean

Depuis

1.2.0

Références $name.

Référencé par Input\get().

get()

get	(		$name,
			$default = null,
			$filter = 'cmd'
	)

Gets a value from the input data.

Paramètres

string	$name	Name of the value to get.
mixed	$default	Default value to return if variable does not exist.
string	$filter	Filter to apply to the value.

Renvoie

mixed The filtered input value.

Voir également

::clean()

Depuis

1.0

Références $default, Input\$filter, $name, et Input\exists().

getArray()

getArray	(	array	$vars = [],
			$datasource = null
	)

Gets an array of values from the request.

Paramètres

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 default case in InputFilter::clean.
mixed	$datasource	Array to retrieve data from, or null

Renvoie

mixed The filtered input data.

Depuis

1.0

Références Input\$data, $results, elseif, et null.

getInputForRequestMethod()

getInputForRequestMethod

(

)

Get the Input instance holding the data for the current request method

Renvoie

Input

Depuis

1.3.0

Références $this, et Input\getMethod().

getMethod()

getMethod

(

)

Gets the request method.

Renvoie

string The request method.

Depuis

1.0

Référencé par Input\getInputForRequestMethod().

set()

set	(		$name,
			$value
	)

Sets a value

Paramètres

string	$name	Name of the value to set.
mixed	$value	Value to assign to the input.

Renvoie

void

Depuis

1.0

Références $name, et $value.

Documentation des champs

$data

$data = []

protected

Référencé par Files\decodeData(), et Input\getArray().

$filter

$filter

protected

Référencé par Input\__call(), et Input\get().

$inputs

$inputs = []

protected

$options

$options = []

protected

Référencé par Cookie\__construct(), Files\__construct(), Json\__construct(), Input\__construct(), Input\__get(), et Cookie\set().

ALLOWED_GLOBALS

const ALLOWED_GLOBALS = ['REQUEST', 'GET', 'POST', 'FILES', 'SERVER', 'ENV']

private

---

La documentation de cette classe a été générée à partir du fichier suivant :

• vendor/joomla/input/src/Input.php