TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
CommandArgumentDefinition Class Reference

Public Member Functions

 __construct ($name, $required, $description)
 
 getName ()
 
 getDashedName ()
 
 getDescription ()
 
 isRequired ()
 

Protected Attributes

 $name = ''
 
 $required = false
 
 $description = ''
 

Detailed Description

Represents a CommandArgumentDefinition

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 22 of file CommandArgumentDefinition.php.

Constructor & Destructor Documentation

__construct (   $name,
  $required,
  $description 
)

Constructor

Parameters
string$namename of the command argument (= parameter name)
bool$requireddefines whether this argument is required or optional
string$descriptiondescription of the argument

Definition at line 46 of file CommandArgumentDefinition.php.

References CommandArgumentDefinition\$description, CommandArgumentDefinition\$name, and CommandArgumentDefinition\$required.

Member Function Documentation

getDashedName ( )

Returns the lowercased name with dashes as word separator

Returns
string

Definition at line 66 of file CommandArgumentDefinition.php.

getDescription ( )
Returns
string

Definition at line 76 of file CommandArgumentDefinition.php.

References CommandArgumentDefinition\$description.

getName ( )
Returns
string

Definition at line 56 of file CommandArgumentDefinition.php.

References CommandArgumentDefinition\$name.

isRequired ( )
Returns
string

Definition at line 84 of file CommandArgumentDefinition.php.

References CommandArgumentDefinition\$required.

Member Data Documentation

$description = ''
protected
$name = ''
protected
$required = false
protected