Symfony\Component\Console\Input\InputArgument
Represents a command line argument.
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
class InputArgument
{
- // constants
- const REQUIRED = 1;
- const OPTIONAL = 2;
- const IS_ARRAY = 4;
- // members
- private $name;
- private $mode;
- private $default;
- private $description;
- // methods
- public void __construct()
- public string getName()
- public Boolean isRequired()
- public Boolean isArray()
- public void setDefault()
- public mixed getDefault()
- public string getDescription()
Constants
Name | Value |
---|---|
REQUIRED | 1 |
OPTIONAL | 2 |
IS_ARRAY | 4 |
Members
private
- $default
- $description
- $mode
- $name
Methods
public
- __construct() — Constructor.
- getDefault() — Returns the default value.
- getDescription() — Returns the description text.
- getName() — Returns the argument name.
- isArray() — Returns true if the argument can take multiple values.
- isRequired() — Returns true if the argument is required.
- setDefault() — Sets the default value.