Extbase\MVC\Controller

Class Tx_Extbase_MVC_Controller_Argument


public class Tx_Extbase_MVC_Controller_Argument

A controller argument

Package: Extbase
Subpackage: MVC\Controller
Version: $ID:$
Scope: prototype


Method Summary

 void __construct(string $name, string $dataType='Text')
 string getName()
 Tx_Extbase_MVC_Controller_Argument setShortName(string $shortName)
 string getShortName()
 Tx_Extbase_MVC_Controller_Argument setDataType(string $dataType)
 string getDataType()
 Tx_Extbase_MVC_Controller_Argument setRequired(boolean $required)
 boolean isRequired()
 void setDefaultValue(mixed $defaultValue)
 mixed getDefaultValue()
 Tx_Extbase_MVC_Controller_Argument setValidator($validator)
 Tx_Extbase_MVC_Controller_Argument setNewValidatorConjunction(array $objectNames)
  getValidator()
 object getValue()
 string __toString()

Method Detail

__construct

public void __construct(string $name, string $dataType='Text')

Constructs this controller argument

Parameters

$name - Name of this argument
$dataType - The data type of this argument

getName

public string getName()

Returns the name of this argument

setShortName

public Tx_Extbase_MVC_Controller_Argument setShortName(string $shortName)

Sets the short name of this argument.

Parameters

$shortName - A "short name" - a single character

getShortName

public string getShortName()

Returns the short name of this argument

setDataType

public Tx_Extbase_MVC_Controller_Argument setDataType(string $dataType)

Sets the data type of this argument's value

Parameters

$dataType - The data type. Can be either a built-in type such as "Text" or "Integer" or a fully qualified object name

getDataType

public string getDataType()

Returns the data type of this argument's value

setRequired

public Tx_Extbase_MVC_Controller_Argument setRequired(boolean $required)

Marks this argument to be required

Parameters

$required - TRUE if this argument should be required

isRequired

public boolean isRequired()

Returns TRUE if this argument is required

setDefaultValue

public void setDefaultValue(mixed $defaultValue)

Sets the default value of the argument

Parameters

$defaultValue - Default value

getDefaultValue

public mixed getDefaultValue()

Returns the default value of this argument

setValidator

public Tx_Extbase_MVC_Controller_Argument setValidator($validator)

Sets a custom validator which is used supplementary to the base validation

Parameters

$validator - The actual validator object

setNewValidatorConjunction

public Tx_Extbase_MVC_Controller_Argument setNewValidatorConjunction(array $objectNames)

Create and set a validator chain

Parameters

$objectNames - names of the validators

getValidator

public  getValidator()

Returns the set validator

getValue

public object getValue()

Returns the value of this argument

__toString

public string __toString()

Returns a string representation of this argument's value