Référence de la classe Input

Graphe d'héritage de Input:

Fonctions membres publiques
	__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 publiques hérités de InputInterface
	getFirstArgument ()
	hasParameterOption ($values, bool $onlyParams=false)
	getParameterOption ($values, $default=false, bool $onlyParams=false)

Fonctions membres protégées
	parse ()

Attributs protégés
	$definition
	$stream
	$options = []
	$arguments = []
	$interactive = true

Description détaillée

Input is the base class for all concrete Input classes.

Three concrete classes are provided by default:

• ArgvInput: The input comes from the CLI arguments (argv)
• StringInput: The input is provided as a string
• ArrayInput: The input is provided as an array

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

InputDefinition

$definition = null

)

Références Input\$definition, Input\bind(), null, et Input\validate().

Documentation des fonctions membres

bind()

bind

(

InputDefinition

$definition

)

{Binds the current Input instance with the given arguments and options.

Exceptions

RuntimeException

}

Implémente InputInterface.

Références Input\$definition, et Input\parse().

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

escapeToken()

escapeToken

(

string

$token

)

Escapes a token through escapeshellarg if it contains unsafe chars.

Renvoie

string

Référencé par ArrayInput\__toString(), et ArgvInput\__toString().

getArgument()

getArgument

(

string

$name

)

{Returns the argument value for a given argument name.

Renvoie

mixed

Exceptions

InvalidArgumentException

When argument given doesn't exist

}

Implémente InputInterface.

Références $name.

getArguments()

getArguments

(

)

{Returns all the given arguments merged with the default values.

Renvoie

array<string|bool|int|float|array|null>

}

Implémente InputInterface.

Références Input\$arguments.

getOption()

getOption

(

string

$name

)

{Returns the option value for a given option name.

Renvoie

mixed

Exceptions

InvalidArgumentException

When option given doesn't exist

}

Implémente InputInterface.

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

getOptions()

getOptions

(

)

{Returns all the given options merged with the default values.

Renvoie

array<string|bool|int|float|array|null>

}

Implémente InputInterface.

Références Input\$options.

getStream()

getStream

(

)

{Returns the input stream.

Renvoie

resource|null

}

Implémente StreamableInputInterface.

Références Input\$stream.

hasArgument()

hasArgument

(

string

$name

)

{Returns true if an InputArgument object exists by name or position.

Renvoie

bool

}

Implémente InputInterface.

Références $name.

hasOption()

hasOption

(

string

$name

)

{Returns true if an InputOption object exists by name.

Renvoie

bool

}

Implémente InputInterface.

Références $name.

isInteractive()

isInteractive

(

)

{Is this input means interactive?

Renvoie

bool

}

Implémente InputInterface.

Références Input\$interactive.

parse()

parse ( )

abstractprotected

Processes command line arguments.

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

setArgument()

setArgument	(	string	$name,
			$value
	)

{Sets an argument value by name.

Paramètres

mixed

$value

The argument value

Exceptions

InvalidArgumentException

When argument given doesn't exist

}

Implémente InputInterface.

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

setInteractive()

setInteractive

(

bool

$interactive

)

{Sets the input interactivity.}

Implémente InputInterface.

Références Input\$interactive.

setOption()

setOption	(	string	$name,
			$value
	)

{Sets an option value by name.

Paramètres

mixed

$value

The option value

Exceptions

InvalidArgumentException

When option given doesn't exist

}

Implémente InputInterface.

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

setStream()

setStream

(

$stream

)

{Sets the input stream to read from when interacting with the user.This is mainly useful for testing purpose.

Paramètres

resource

$stream

The input stream

}

Implémente StreamableInputInterface.

Références Input\$stream.

validate()

validate

(

)

{Validates the input.

Exceptions

RuntimeException

When not enough arguments are given

}

Implémente InputInterface.

Références Input\$arguments, et Input\$definition.

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

Documentation des champs

$arguments

$arguments = []

protected

Référencé par Input\getArguments(), et Input\validate().

$definition

$definition

protected

Référencé par ArrayInput\__construct(), Input\__construct(), ArgvInput\__construct(), Input\bind(), CompletionInput\bind(), et Input\validate().

$interactive

$interactive = true

protected

Référencé par Input\isInteractive(), et Input\setInteractive().

$options

$options = []

protected

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

$stream

$stream

protected

Référencé par Input\getStream(), et Input\setStream().

---

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

• vendor/symfony/console/Input/Input.php