TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition:

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()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::__construct	(		$name,
			$type,
			$description,
			$required,
			$defaultValue = NULL,
			$isMethodParameter = FALSE
	)

Constructor for this argument definition.

Parameters

string	$name	Name of argument
string	$type	Type of argument
string	$description	Description of argument
boolean	$required	TRUE if argument is required
mixed	$defaultValue	Default value
boolean	$isMethodParameter	TRUE if this argument is a method parameter

Definition at line 71 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$defaultValue, TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$description, TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$isMethodParameter, TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$name, TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$required, TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$type, and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\isMethodParameter().

Member Function Documentation

getDefaultValue()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::getDefaultValue

(

)

Get the default value, if set

Returns

mixed Default value

Definition at line 121 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$defaultValue.

getDescription()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::getDescription

(

)

Get the description of the argument

Returns

string Description of argument

Definition at line 103 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$description.

getName()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::getName

(

)

Get the name of the argument

Returns

string Name of argument

Definition at line 85 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$name.

getType()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::getType

(

)

Get the type of the argument

Returns

string Type of argument

Definition at line 94 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$type.

isMethodParameter()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::isMethodParameter

(

)

TRUE if it is a method parameter

Returns

boolean TRUE if it's a method parameter

Definition at line 130 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$isMethodParameter.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct().

isRequired()

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::isRequired

(

)

Get the optionality of the argument

Returns

boolean TRUE if argument is optional

Definition at line 112 of file ArgumentDefinition.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\$required.

Member Data Documentation

$defaultValue

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$defaultValue = NULL

protected

Definition at line 52 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\getDefaultValue().

$description

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$description

protected

Definition at line 38 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\getDescription().

$isMethodParameter

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$isMethodParameter = FALSE

protected

Definition at line 59 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\isMethodParameter().

$name

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$name

protected

Definition at line 24 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\getName().

$required

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$required = FALSE

protected

Definition at line 45 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\isRequired().

$type

TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition::$type

protected

Definition at line 31 of file ArgumentDefinition.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\__construct(), and TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition\getType().