Input\InputOption (Component\Console)
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, int $mode = null, string $description = '', mixed $default = null) Constructor. | ||
string | getShortcut() Returns the option shortcut. | |
string | getName() Returns the option name. | |
bool | acceptValue() Returns true if the option accepts a value. | |
bool | isValueRequired() Returns true if the option requires a value. | |
bool | isValueOptional() Returns true if the option takes an optional value. | |
bool | 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. | |
bool | equals(InputOption $option) Checks whether the given option equals this one. |
Details
public __construct(string $name, string|array $shortcut = null, int $mode = null, string $description = '', mixed $default = null)
Constructor.
public string getShortcut()
Returns the option shortcut.
public string getName()
Returns the option name.
public bool acceptValue()
Returns true if the option accepts a value.
public bool isValueRequired()
Returns true if the option requires a value.
public bool isValueOptional()
Returns true if the option takes an optional value.
public bool isArray()
Returns true if the option can take multiple values.
public setDefault(mixed $default = null)
Sets the default value.
public mixed getDefault()
Returns the default value.
public string getDescription()
Returns the description text.
public bool equals(InputOption $option)
Checks whether the given option equals this one.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Input/InputOption.html