Référence de la classe InputOption

Fonctions membres publiques
	__construct (string $name, $shortcut=null, int $mode=null, string $description='', $default=null)
	getShortcut ()
	getName ()
	acceptValue ()
	isValueRequired ()
	isValueOptional ()
	isArray ()
	isNegatable ()
	setDefault ($default=null)
	getDefault ()
	getDescription ()
	equals (self $option)

Champs de données
const	VALUE_NONE = 1
const	VALUE_REQUIRED = 2
const	VALUE_OPTIONAL = 4
const	VALUE_IS_ARRAY = 8
const	VALUE_NEGATABLE = 16

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

Description détaillée

Represents a command line option.

Auteur

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

Documentation des constructeurs et destructeur

__construct()

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

Paramètres

string | array | null	$shortcut	The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
int | null	$mode	The option mode: One of the VALUE_* constants
string | bool | int | float | array | null	$default	The default value (must be null for self::VALUE_NONE)

Exceptions

InvalidArgumentException

If option mode is invalid or incompatible

Références InputOption\$default, InputOption\$description, InputOption\$mode, InputOption\$name, InputOption\$shortcut, InputOption\acceptValue(), description, elseif, InputOption\isArray(), InputOption\isNegatable(), name, null, et InputOption\setDefault().

Documentation des fonctions membres

acceptValue()

acceptValue

(

)

Returns true if the option accepts a value.

Renvoie

bool true if value mode is not self::VALUE_NONE, false otherwise

Références InputOption\isValueOptional(), et InputOption\isValueRequired().

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

equals()

equals

(

self

$option

)

Checks whether the given option equals this one.

Renvoie

bool

Références $option, InputOption\getDefault(), InputOption\getName(), InputOption\getShortcut(), InputOption\isArray(), InputOption\isNegatable(), InputOption\isValueOptional(), et InputOption\isValueRequired().

getDefault()

getDefault

(

)

Returns the default value.

Renvoie

string|bool|int|float|array|null

Références InputOption\$default.

Référencé par TextDescriptor\describeInputOption(), et InputOption\equals().

getDescription()

getDescription

(

)

Returns the description text.

Renvoie

string

Références InputOption\$description.

Référencé par MarkdownDescriptor\describeInputOption().

getName()

getName

(

)

Returns the option name.

Renvoie

string

Références InputOption\$name.

Référencé par InputOption\equals().

getShortcut()

getShortcut

(

)

Returns the option shortcut.

Renvoie

string|null

Références InputOption\$shortcut.

Référencé par InputOption\equals().

isArray()

isArray

(

)

Returns true if the option can take multiple values.

Renvoie

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

Références InputOption\$mode.

Référencé par InputOption\__construct(), InputOption\equals(), et InputOption\setDefault().

isNegatable()

isNegatable

(

)

Références InputOption\$mode.

Référencé par InputOption\__construct(), InputOption\equals(), et InputOption\setDefault().

isValueOptional()

isValueOptional

(

)

Returns true if the option takes an optional value.

Renvoie

bool true if value mode is self::VALUE_OPTIONAL, false otherwise

Références InputOption\$mode.

Référencé par InputOption\acceptValue(), et InputOption\equals().

isValueRequired()

isValueRequired

(

)

Returns true if the option requires a value.

Renvoie

bool true if value mode is self::VALUE_REQUIRED, false otherwise

Références InputOption\$mode.

Référencé par InputOption\acceptValue(), et InputOption\equals().

setDefault()

setDefault

(

$default = null

)

Paramètres

string | bool | int | float | array | null

$default

Références InputOption\$default, InputOption\acceptValue(), elseif, InputOption\isArray(), InputOption\isNegatable(), et null.

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

Documentation des champs

$default

$default

private

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

$description

$description

private

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

$mode

$mode

private

Référencé par InputOption\__construct(), InputOption\isArray(), InputOption\isNegatable(), InputOption\isValueOptional(), et InputOption\isValueRequired().

$name

$name

private

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

$shortcut

$shortcut

private

Référencé par InputOption\__construct(), et InputOption\getShortcut().

VALUE_IS_ARRAY

const VALUE_IS_ARRAY = 8

The option accepts multiple values (e.g. –dir=/foo –dir=/bar).

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

VALUE_NEGATABLE

const VALUE_NEGATABLE = 16

The option may have either positive or negative value (e.g. –ansi or –no-ansi).

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

VALUE_NONE

const VALUE_NONE = 1

Do not accept input for the option (e.g. –yell). This is the default behavior of options.

Référencé par ListCommand\configure(), HelpCommand\configure(), DumpCompletionCommand\configure(), DebugRouterCommand\configure(), RemoveOldFilesCommand\configure(), TasksRunCommand\configure(), ExportCommand\configure(), ConsoleApplication\getDefaultInputDefinition(), et Application\getDefaultInputDefinition().

VALUE_OPTIONAL

const VALUE_OPTIONAL = 4

The option may or may not have a value (e.g. –yell or –yell=loud).

Référencé par SessionGcCommand\configure(), ChangeUserPasswordCommand\configure(), ExportCommand\configure(), DeleteUserCommand\configure(), ImportCommand\configure(), AddUserToGroupCommand\configure(), RemoveUserFromGroupCommand\configure(), AddUserCommand\configure(), et ConsoleApplication\getDefaultInputDefinition().

VALUE_REQUIRED

const VALUE_REQUIRED = 2

A value must be passed when the option is used (e.g. –iterations=5 or -i5).

Référencé par ListCommand\configure(), HelpCommand\configure(), CompleteCommand\configure(), LintCommand\configure(), ServerDumpCommand\configure(), ExtensionInstallCommand\configure(), ExtensionDiscoverInstallCommand\configure(), ExtensionsListCommand\configure(), TasksRunCommand\configure(), FinderIndexCommand\configure(), ExportCommand\configure(), TasksStateCommand\configure(), ImportCommand\configure(), et GetConfigurationCommand\configure().

---

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

• InputOption.php