Symfony2 API
Class

Symfony\Component\Console\Input\InputOption

class InputOption

Represents a command line option.

Constants

VALUE_NONE

VALUE_REQUIRED

VALUE_OPTIONAL

VALUE_IS_ARRAY

Methods

__construct(string $name, string|array $shortcut = null, integer $mode = null, string $description = '', mixed $default = null)

Constructor.
string getShortcut()

Returns the option shortcut.
string getName()

Returns the option name.
Boolean acceptValue()

Returns true if the option accepts a value.
Boolean isValueRequired()

Returns true if the option requires a value.
Boolean isValueOptional()

Returns true if the option takes an optional value.
Boolean isArray()

Returns true if the option can take multiple values.
setDefault(mixed $default = null)

Sets the default value.
mixed getDefault()

Returns the default value.
string getDescription()

Returns the description text.
Boolean equals(InputOption $option)

Checks whether the given option equals this one

Details

at line 47
public __construct(string $name, string|array $shortcut = null, integer $mode = null, string $description = '', mixed $default = null)

Constructor.

Parameters

string $name The option name
string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
integer $mode The option mode: One of the VALUE_* constants
string $description A description text
mixed $default The default value (must be null for self::VALUE_REQUIRED or self::VALUE_NONE)

Exceptions

InvalidArgumentException If option mode is invalid or incompatible

at line 97
public string getShortcut()

Returns the option shortcut.

Return Value

string The shortcut

at line 107
public string getName()

Returns the option name.

Return Value

string The name

at line 117
public Boolean acceptValue()

Returns true if the option accepts a value.

Return Value

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

at line 127
public Boolean isValueRequired()

Returns true if the option requires a value.

Return Value

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

at line 137
public Boolean isValueOptional()

Returns true if the option takes an optional value.

Return Value

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

at line 147
public Boolean isArray()

Returns true if the option can take multiple values.

Return Value

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

at line 159
public setDefault(mixed $default = null)

Sets the default value.

Parameters

mixed $default The default value

Exceptions

LogicException When incorrect default value is given

at line 181
public mixed getDefault()

Returns the default value.

Return Value

mixed The default value

at line 191
public string getDescription()

Returns the description text.

Return Value

string The description text

at line 202
public Boolean equals(InputOption $option)

Checks whether the given option equals this one

Parameters

InputOption $option option to compare

Return Value

Boolean