Graphe d'héritage de ArgvInput:

Fonctions membres publiques
	__construct (array $argv=null, 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
	setTokens (array $tokens)

	parse ()

	parseToken (string $token, bool $parseOptions)

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

Fonctions membres privées
	parseShortOption (string $token)

	parseShortOptionSet (string $name)

	parseLongOption (string $token)

	parseArgument (string $token)

	addShortOption (string $shortcut, $value)

	addLongOption (string $name, $value)

Attributs privés
	$tokens

	$parsed

Membres hérités additionnels
Attributs protégés hérités de Input
	$definition

	$stream

	$options = []

	$arguments = []

	$interactive = true

Description détaillée

ArgvInput represents an input coming from the CLI arguments.

Usage:

$input = new ArgvInput();

By default, the ‘$_SERVER['argv’]` array is used for the input values.

This can be overridden by explicitly passing the input values in the constructor:

$input = new ArgvInput($_SERVER['argv']);

If you pass it yourself, don't forget that the first element of the array is the name of the running application.

When passing an argument to the constructor, be sure that it respects the same rules as the argv one. It's almost always better to use the StringInput when you want to provide your own input.

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

Voir également: http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html; http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	array	$argv = `null`,
		InputDefinition	$definition = `null`
	)

Références $argv, Input\$definition, 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 ArgvInput\$tokens, et Input\escapeToken().

◆ addLongOption()

addLongOption	(	string	$name,
			$value
	)

private

Adds a long option value.

Exceptions

RuntimeException When option given doesn't exist

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

Référencé par ArgvInput\addShortOption(), ArgvInput\parseLongOption(), et ArgvInput\parseShortOptionSet().

◆ addShortOption()

addShortOption	(	string	$shortcut,
			$value
	)

private

Adds a short option value.

Exceptions

RuntimeException When option given doesn't exist

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

Référencé par ArgvInput\parseShortOption().

◆ getFirstArgument()

getFirstArgument ( )

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

Renvoie: string|null

}

Implémente InputInterface.

Références $i, $name, elseif, et null.

Référencé par CompleteCommand\findCommand().

◆ 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, ArgvInput\$tokens, et $value.

◆ 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