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

Public Member Functions

 __construct ($name, $type, $description, $required, $defaultValue=null, $isMethodParameter=false)
 
 getName ()
 
 getType ()
 
 getDescription ()
 
 isRequired ()
 
 getDefaultValue ()
 
 isMethodParameter ()
 

Protected Attributes

 $name
 
 $type
 
 $description
 
 $required = false
 
 $defaultValue = null
 
 $isMethodParameter = false
 

Detailed Description

Argument definition of each view helper argument

Definition at line 17 of file ArgumentDefinition.php.

Constructor & Destructor Documentation

__construct (   $name,
  $type,
  $description,
  $required,
  $defaultValue = null,
  $isMethodParameter = false 
)

Constructor for this argument definition.

Parameters
string$nameName of argument
string$typeType of argument
string$descriptionDescription of argument
bool$requiredTRUE if argument is required
mixed$defaultValueDefault value
bool$isMethodParameterTRUE if this argument is a method parameter

Definition at line 71 of file ArgumentDefinition.php.

References ArgumentDefinition\$defaultValue, ArgumentDefinition\$description, ArgumentDefinition\$isMethodParameter, ArgumentDefinition\$name, ArgumentDefinition\$required, ArgumentDefinition\$type, and ArgumentDefinition\isMethodParameter().

Member Function Documentation

getDefaultValue ( )

Get the default value, if set

Returns
mixed Default value

Definition at line 126 of file ArgumentDefinition.php.

References ArgumentDefinition\$defaultValue.

getDescription ( )

Get the description of the argument

Returns
string Description of argument

Definition at line 106 of file ArgumentDefinition.php.

References ArgumentDefinition\$description.

getName ( )

Get the name of the argument

Returns
string Name of argument

Definition at line 86 of file ArgumentDefinition.php.

References ArgumentDefinition\$name.

getType ( )

Get the type of the argument

Returns
string Type of argument

Definition at line 96 of file ArgumentDefinition.php.

References ArgumentDefinition\$type.

isMethodParameter ( )

TRUE if it is a method parameter

Returns
bool TRUE if it's a method parameter

Definition at line 136 of file ArgumentDefinition.php.

References ArgumentDefinition\$isMethodParameter.

Referenced by ArgumentDefinition\__construct().

isRequired ( )

Get the optionality of the argument

Returns
bool TRUE if argument is optional

Definition at line 116 of file ArgumentDefinition.php.

References ArgumentDefinition\$required.

Member Data Documentation

$defaultValue = null
protected
$description
protected
$isMethodParameter = false
protected
$name
protected
$required = false
protected
$type
protected