![]() |
TYPO3
7.6
|
Public Member Functions | |
__construct ($name, $mode=null, $description= '', $default=null) | |
getName () | |
isRequired () | |
isArray () | |
setDefault ($default=null) | |
getDefault () | |
getDescription () | |
Public Attributes | |
const | REQUIRED = 1 |
const | OPTIONAL = 2 |
const | IS_ARRAY = 4 |
Private Attributes | |
$name | |
$mode | |
$default | |
$description | |
Represents a command line argument.
Definition at line 21 of file InputArgument.php.
__construct | ( | $name, | |
$mode = null , |
|||
$description = '' , |
|||
$default = null |
|||
) |
Constructor.
string | $name | The argument name |
int | $mode | The argument mode: self::REQUIRED or self::OPTIONAL |
string | $description | A description text |
mixed | $default | The default value (for self::OPTIONAL mode only) |
\InvalidArgumentException | When argument mode is not valid |
Definition at line 44 of file InputArgument.php.
References InputArgument\$default, InputArgument\$description, InputArgument\$mode, InputArgument\$name, elseif, and InputArgument\setDefault().
getDefault | ( | ) |
Returns the default value.
Definition at line 118 of file InputArgument.php.
References InputArgument\$default.
Referenced by MarkdownDescriptor\describeInputArgument(), TextDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), and XmlDescriptor\getInputArgumentDocument().
getDescription | ( | ) |
Returns the description text.
Definition at line 128 of file InputArgument.php.
References InputArgument\$description.
Referenced by MarkdownDescriptor\describeInputArgument(), TextDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), and XmlDescriptor\getInputArgumentDocument().
getName | ( | ) |
Returns the argument name.
Definition at line 64 of file InputArgument.php.
References InputArgument\$name.
Referenced by InputDefinition\addArgument(), TextDescriptor\describeInputArgument(), MarkdownDescriptor\describeInputArgument(), TextDescriptor\describeInputDefinition(), JsonDescriptor\getInputArgumentData(), and XmlDescriptor\getInputArgumentDocument().
isArray | ( | ) |
Returns true if the argument can take multiple values.
Definition at line 84 of file InputArgument.php.
References InputArgument\$mode.
Referenced by InputDefinition\addArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), XmlDescriptor\getInputArgumentDocument(), and InputArgument\setDefault().
isRequired | ( | ) |
Returns true if the argument is required.
Definition at line 74 of file InputArgument.php.
References InputArgument\$mode.
Referenced by InputDefinition\addArgument(), MarkdownDescriptor\describeInputArgument(), JsonDescriptor\getInputArgumentData(), and XmlDescriptor\getInputArgumentDocument().
setDefault | ( | $default = null | ) |
Sets the default value.
mixed | $default | The default value |
\LogicException | When incorrect default value is given |
Definition at line 96 of file InputArgument.php.
References InputArgument\$default, elseif, and InputArgument\isArray().
Referenced by InputArgument\__construct().
|
private |
Definition at line 29 of file InputArgument.php.
Referenced by InputArgument\__construct(), InputArgument\getDefault(), and InputArgument\setDefault().
|
private |
Definition at line 30 of file InputArgument.php.
Referenced by InputArgument\__construct(), and InputArgument\getDescription().
|
private |
Definition at line 28 of file InputArgument.php.
Referenced by InputArgument\__construct(), InputArgument\isArray(), and InputArgument\isRequired().
|
private |
Definition at line 27 of file InputArgument.php.
Referenced by InputArgument\__construct(), and InputArgument\getName().
const IS_ARRAY = 4 |
Definition at line 25 of file InputArgument.php.
Referenced by InputDefinitionTest\getGetSynopsisData(), ObjectsProvider\getInputArguments(), InputDefinitionTest\testArrayArgumentHasToBeLast(), InputDefinitionTest\testGetArgumentDefaults(), InputArgumentTest\testIsArray(), InputDefinitionTest\testLegacyAsText(), InputDefinitionTest\testLegacyAsXml(), ArgvInputTest\testParseArrayArgument(), InputArgumentTest\testSetDefault(), and InputArgumentTest\testSetDefaultWithArrayArgument().
const OPTIONAL = 2 |
Definition at line 24 of file InputArgument.php.
Referenced by HelpCommand\configure(), ObjectsProvider\getInputArguments(), InputTest\testArguments(), InputDefinitionTest\testGetArgumentDefaults(), InputArgumentTest\testGetDefault(), InputTest\testGetInvalidArgument(), InputArgumentTest\testIsArray(), InputDefinitionTest\testLegacyAsText(), InputDefinitionTest\testLegacyAsXml(), InputArgumentTest\testModes(), InputArgumentTest\testSetDefault(), and InputTest\testSetInvalidArgument().
const REQUIRED = 1 |
Definition at line 23 of file InputArgument.php.
Referenced by DescriptorCommand2\configure(), ApplicationTest\getAddingAlreadySetDefinitionElementData(), Application\getDefaultInputDefinition(), InputDefinitionTest\getGetSynopsisData(), ObjectsProvider\getInputArguments(), ObjectsProvider\getInputDefinitions(), InputDefinitionTest\initializeArguments(), InputArgumentTest\testModes(), InputArgumentTest\testSetDefaultWithRequiredArgument(), InputTest\testValidate(), and InputTest\testValidateWithMissingArguments().