Référence de la classe InputDefinition

Fonctions membres publiques
	__construct (array $definition=[])
	setDefinition (array $definition)
	setArguments (array $arguments=[])
	addArguments (?array $arguments=[])
	addArgument (InputArgument $argument)
	getArgument ($name)
	hasArgument ($name)
	getArguments ()
	getArgumentCount ()
	getArgumentRequiredCount ()
	getArgumentDefaults ()
	setOptions (array $options=[])
	addOptions (array $options=[])
	addOption (InputOption $option)
	getOption (string $name)
	hasOption (string $name)
	getOptions ()
	hasShortcut (string $name)
	hasNegation (string $name)
	getOptionForShortcut (string $shortcut)
	getOptionDefaults ()
	shortcutToName (string $shortcut)
	negationToName (string $negation)
	getSynopsis (bool $short=false)

Attributs privés
	$arguments
	$requiredCount
	$lastArrayArgument
	$lastOptionalArgument
	$options
	$negations
	$shortcuts

Description détaillée

A InputDefinition represents a set of valid command line arguments and options.

Usage:

$definition = new InputDefinition([
    new InputArgument('name', InputArgument::REQUIRED),
    new InputOption('foo', 'f', InputOption::VALUE_REQUIRED),
]);

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$definition = []

)

Paramètres

array

$definition

An array of InputArgument and InputOption instance

Références InputDefinition\setDefinition().

Documentation des fonctions membres

addArgument()

addArgument

(

InputArgument

$argument

)

Exceptions

LogicException

When incorrect argument is given

Références InputDefinition\$lastOptionalArgument, InputDefinition\$requiredCount, InputArgument\getName(), InputArgument\isArray(), InputArgument\isRequired(), et null.

Référencé par InputDefinition\addArguments().

addArguments()

addArguments

(

?array

$arguments = []

)

Adds an array of InputArgument objects.

Paramètres

InputArgument[]

$arguments An array of InputArgument objects

Références InputDefinition\$arguments, InputDefinition\addArgument(), et null.

Référencé par InputDefinition\setArguments().

addOption()

addOption

(

InputOption

$option

)

Exceptions

LogicException

When option given already exist

Références $option, et $this.

Référencé par InputDefinition\addOptions().

addOptions()

addOptions

(

array

$options = []

)

Adds an array of InputOption objects.

Paramètres

InputOption[]

$options An array of InputOption objects

Références $option, InputDefinition\$options, et InputDefinition\addOption().

Référencé par InputDefinition\setOptions().

getArgument()

getArgument

(

$name

)

Returns an InputArgument by name or by position.

Paramètres

string | int

$name

The InputArgument name or position

Renvoie

InputArgument

Exceptions

InvalidArgumentException

When argument given doesn't exist

Références InputDefinition\$arguments, $name, et InputDefinition\hasArgument().

getArgumentCount()

getArgumentCount

(

)

Returns the number of InputArguments.

Renvoie

int

Références null.

getArgumentDefaults()

getArgumentDefaults

(

)

Renvoie

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

getArgumentRequiredCount()

getArgumentRequiredCount

(

)

Returns the number of required InputArguments.

Renvoie

int

Références InputDefinition\$requiredCount.

getArguments()

getArguments

(

)

Gets the array of InputArgument objects.

Renvoie

InputArgument[]

Références InputDefinition\$arguments.

Référencé par MarkdownDescriptor\describeInputDefinition(), TextDescriptor\describeInputDefinition(), JsonDescriptor\getInputDefinitionData(), XmlDescriptor\getInputDefinitionDocument(), et InputDefinition\getSynopsis().

getOption()

getOption

(

string

$name

)

Returns an InputOption by name.

Renvoie

InputOption

Exceptions

InvalidArgumentException

When option given doesn't exist

Références $name, et InputDefinition\hasOption().

Référencé par InputDefinition\getOptionForShortcut().

getOptionDefaults()

getOptionDefaults

(

)

Renvoie

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

Références $option.

getOptionForShortcut()

getOptionForShortcut

(

string

$shortcut

)

Gets an InputOption by shortcut.

Renvoie

InputOption

Références InputDefinition\getOption(), et InputDefinition\shortcutToName().

getOptions()

getOptions

(

)

Gets the array of InputOption objects.

Renvoie

InputOption[]

Références InputDefinition\$options.

Référencé par MarkdownDescriptor\describeInputDefinition(), TextDescriptor\describeInputDefinition(), JsonDescriptor\getInputDefinitionData(), XmlDescriptor\getInputDefinitionDocument(), et InputDefinition\getSynopsis().

getSynopsis()

getSynopsis

(

bool

$short = false

)

Gets the synopsis.

Renvoie

string

Références $option, $value, elseif, InputDefinition\getArguments(), et InputDefinition\getOptions().

hasArgument()

hasArgument

(

$name

)

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

Paramètres

string | int

$name

The InputArgument name or position

Renvoie

bool

Références InputDefinition\$arguments, et $name.

Référencé par InputDefinition\getArgument().

hasNegation()

hasNegation

(

string

$name

)

Returns true if an InputOption object exists by negated name.

Références $name.

hasOption()

hasOption

(

string

$name

)

Returns true if an InputOption object exists by name.

This method can't be used to check if the user included the option when executing the command (use getOption() instead).

Renvoie

bool

Références $name.

Référencé par InputDefinition\getOption().

hasShortcut()

hasShortcut

(

string

$name

)

Returns true if an InputOption object exists by shortcut.

Renvoie

bool

Références $name.

negationToName()

negationToName

(

string

$negation

)

Returns the InputOption name given a negation.

Exceptions

InvalidArgumentException

When option given does not exist

setArguments()

setArguments

(

array

$arguments = []

)

Sets the InputArgument objects.

Paramètres

InputArgument[]

$arguments An array of InputArgument objects

Références InputDefinition\$arguments, InputDefinition\addArguments(), et null.

Référencé par InputDefinition\setDefinition().

setDefinition()

setDefinition

(

array

$definition

)

Sets the definition of the input.

Références InputDefinition\$arguments, $item, InputDefinition\$options, InputDefinition\setArguments(), et InputDefinition\setOptions().

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

setOptions()

setOptions

(

array

$options = []

)

Sets the InputOption objects.

Paramètres

InputOption[]

$options An array of InputOption objects

Références InputDefinition\$options, et InputDefinition\addOptions().

Référencé par InputDefinition\setDefinition().

shortcutToName()

shortcutToName

(

string

$shortcut

)

Returns the InputOption name given a shortcut.

Exceptions

InvalidArgumentException

When option given does not exist

Référencé par InputDefinition\getOptionForShortcut().

Documentation des champs

$arguments

$arguments

private

Référencé par InputDefinition\addArguments(), InputDefinition\getArgument(), InputDefinition\getArguments(), InputDefinition\hasArgument(), InputDefinition\setArguments(), et InputDefinition\setDefinition().

$lastArrayArgument

$lastArrayArgument

private

$lastOptionalArgument

$lastOptionalArgument

private

Référencé par InputDefinition\addArgument().

$negations

$negations

private

$options

$options

private

Référencé par InputDefinition\addOptions(), InputDefinition\getOptions(), InputDefinition\setDefinition(), et InputDefinition\setOptions().

$requiredCount

$requiredCount

private

Référencé par InputDefinition\addArgument(), et InputDefinition\getArgumentRequiredCount().

$shortcuts

$shortcuts

private

---

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

• InputDefinition.php