Référence de la classe ArrayInput

Graphe d'héritage de ArrayInput:

Fonctions membres publiques
	__construct (array $parameters, InputDefinition $definition=null)
	getFirstArgument ()
	hasParameterOption ($values, bool $onlyParams=false)
	getParameterOption ($values, $default=false, bool $onlyParams=false)
	__toString ()
Fonctions membres publiques hérités de Input
	__construct (InputDefinition $definition=null)
	bind (InputDefinition $definition)
	validate ()
	isInteractive ()
	setInteractive (bool $interactive)
	getArguments ()
	getArgument (string $name)
	setArgument (string $name, $value)
	hasArgument (string $name)
	getOptions ()
	getOption (string $name)
	setOption (string $name, $value)
	hasOption (string $name)
	escapeToken (string $token)
	setStream ($stream)
	getStream ()

Fonctions membres protégées
	parse ()
Fonctions membres protégées hérités de Input
	parse ()

Fonctions membres privées
	addShortOption (string $shortcut, $value)
	addLongOption (string $name, $value)
	addArgument ($name, $value)

Attributs privés
	$parameters

Membres hérités additionnels
Attributs protégés hérités de Input
	$definition
	$stream
	$options = []
	$arguments = []
	$interactive = true

Description détaillée

ArrayInput represents an input provided as an array.

Usage:

$input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);

Auteur

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

__construct	(	array	$parameters,
		InputDefinition	$definition = null
	)

Références Input\$definition, ArrayInput\$parameters, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

__toString()

__toString

(

)

Returns a stringified representation of the args passed to the command.

Renvoie

string

Références $params, $this, $val, et Input\escapeToken().

addArgument()

addArgument (   $name,   $value  )

private

Adds an argument value.

Paramètres

string | int	$name	The argument name
mixed	$value	The value for the argument

Exceptions

InvalidArgumentException

When argument given doesn't exist

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

Référencé par ArrayInput\parse().

addLongOption()

addLongOption ( string  $name,   $value  )

private

Adds a long option value.

Exceptions

InvalidOptionException	When option given doesn't exist
InvalidOptionException	When a required value is missing

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

Référencé par ArrayInput\addShortOption(), et ArrayInput\parse().

addShortOption()

addShortOption ( string  $shortcut,   $value  )

private

Adds a short option value.

Exceptions

InvalidOptionException

When option given doesn't exist

Références $value, et ArrayInput\addLongOption().

Référencé par ArrayInput\parse().

getFirstArgument()

getFirstArgument

(

)

{Returns the first argument from the raw parameters (not parsed).

Renvoie

string|null

}

Implémente InputInterface.

Références $value, et null.

getParameterOption()

getParameterOption	(		$values,
			$default = false,
		bool	$onlyParams = false
	)

{Returns the value of a raw option (not parsed).This method is to be used to introspect the input parameters before they have been validated. It must be used carefully. Does not necessarily return the correct result for short options when multiple flags are combined in the same option.

Paramètres

string | array	$values	The value(s) to look for in the raw parameters (can be an array)
string | bool | int | float | array | null	$default	The default value to return if no result is found
bool	$onlyParams	Only check real parameters, skip those following an end of options (–) signal

Renvoie

mixed

}

Implémente InputInterface.

Références $default, et elseif.

hasParameterOption()

hasParameterOption	(		$values,
		bool	$onlyParams = false
	)

{Returns true if the raw parameters (not parsed) contain a value.This method is to be used to introspect the input parameters before they have been validated. It must be used carefully. Does not necessarily return the correct result for short options when multiple flags are combined in the same option.

Paramètres

string | array	$values	The values to look for in the raw parameters (can be an array)
bool	$onlyParams	Only check real parameters, skip those following an end of options (–) signal

Renvoie

bool

}

Implémente InputInterface.

parse()

parse ( )

protected

{}

Références $key, $value, ArrayInput\addArgument(), ArrayInput\addLongOption(), ArrayInput\addShortOption(), et elseif.

Documentation des champs

$parameters

$parameters

private

Référencé par ArrayInput\__construct().

---

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

• ArrayInput.php