Référence de la classe InputArgument

Fonctions membres publiques
	__construct (string $name, int $mode=null, string $description='', $default=null)
	getName ()
	isRequired ()
	isArray ()
	setDefault ($default=null)
	getDefault ()
	getDescription ()

Champs de données
const	REQUIRED = 1
const	OPTIONAL = 2
const	IS_ARRAY = 4

Attributs privés
	$name
	$mode
	$default
	$description

Description détaillée

Represents a command line argument.

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$name,
		int	$mode = null,
		string	$description = '',
			$default = null
	)

Paramètres

string	$name	The argument name
int | null	$mode	The argument mode: self::REQUIRED or self::OPTIONAL
string	$description	A description text
string | bool | int | float | array | null	$default	The default value (for self::OPTIONAL mode only)

Exceptions

InvalidArgumentException

When argument mode is not valid

Références InputArgument\$default, InputArgument\$description, InputArgument\$mode, InputArgument\$name, description, elseif, name, null, et InputArgument\setDefault().

Documentation des fonctions membres

getDefault()

getDefault

(

)

Returns the default value.

Renvoie

string|bool|int|float|array|null

Références InputArgument\$default.

Référencé par TextDescriptor\describeInputArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), et XmlDescriptor\getInputArgumentDocument().

getDescription()

getDescription

(

)

Returns the description text.

Renvoie

string

Références InputArgument\$description.

Référencé par TextDescriptor\describeInputArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), et XmlDescriptor\getInputArgumentDocument().

getName()

getName

(

)

Returns the argument name.

Renvoie

string

Références InputArgument\$name.

Référencé par InputDefinition\addArgument(), TextDescriptor\describeInputArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), et XmlDescriptor\getInputArgumentDocument().

isArray()

isArray

(

)

Returns true if the argument can take multiple values.

Renvoie

bool true if mode is self::IS_ARRAY, false otherwise

Références InputArgument\$mode.

Référencé par InputDefinition\addArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), XmlDescriptor\getInputArgumentDocument(), et InputArgument\setDefault().

isRequired()

isRequired

(

)

Returns true if the argument is required.

Renvoie

bool true if parameter mode is self::REQUIRED, false otherwise

Références InputArgument\$mode.

Référencé par InputDefinition\addArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), et XmlDescriptor\getInputArgumentDocument().

setDefault()

setDefault

(

$default = null

)

Sets the default value.

Paramètres

string | bool | int | float | array | null

$default

Exceptions

LogicException

When incorrect default value is given

Références InputArgument\$default, elseif, InputArgument\isArray(), et null.

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

Documentation des champs

$default

$default

private

Référencé par InputArgument\__construct(), InputArgument\getDefault(), et InputArgument\setDefault().

$description

$description

private

Référencé par InputArgument\__construct(), et InputArgument\getDescription().

$mode

$mode

private

Référencé par InputArgument\__construct(), InputArgument\isArray(), et InputArgument\isRequired().

$name

$name

private

Référencé par InputArgument\__construct(), et InputArgument\getName().

IS_ARRAY

const IS_ARRAY = 4

Référencé par LintCommand\configure(), et SetConfigurationCommand\configure().

OPTIONAL

const OPTIONAL = 2

Référencé par HelpCommand\configure(), ListCommand\configure(), DumpCompletionCommand\configure(), DebugEventDispatcherCommand\configure(), CleanCacheCommand\configure(), FinderIndexCommand\configure(), Application\doExecute(), et Application\doRun().

REQUIRED

const REQUIRED = 1

Référencé par ExtensionRemoveCommand\configure(), SetConfigurationCommand\configure(), ConsoleApplication\getDefaultInputDefinition(), et Application\getDefaultInputDefinition().

---

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

• InputArgument.php