BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
ParamProcessor\Definition\StringParam Class Reference
Inheritance diagram for ParamProcessor\Definition\StringParam:
Collaboration diagram for ParamProcessor\Definition\StringParam:

Public Member Functions

 setArrayValues (array $param)
 
 setToLower ($toLower)
 
- Public Member Functions inherited from ParamProcessor\ParamDefinition
 __construct ($type, $name, $default=null, $message=null, $isList=false)
 
 trimDuringClean ()
 
 getAliases ()
 
 hasAlias ($alias)
 
 hasDependency ($dependency)
 
 getAllowedValues ()
 
 setDefault ($default, $manipulate=true)
 
 getDefault ()
 
 getMessage ()
 
 setMessage ($message)
 
 setDoManipulationOfDefault ($doOrDoNotThereIsNoTry)
 
 shouldManipulateDefault ()
 
 addAliases ($aliases)
 
 addDependencies ($dependencies)
 
 getName ()
 
 getTypeMessage ()
 
 getDependencies ()
 
 isRequired ()
 
 isList ()
 
 getDelimiter ()
 
 setDelimiter ($delimiter)
 
 setArrayValues (array $param)
 
 format (IParam $param, array &$definitions, array $params)
 
 getType ()
 
 getValueParser ()
 
 getValueValidator ()
 
 setValueParser (ValueParser $parser)
 
 setValueValidator (ValueValidator $validator)
 
 setValidationCallback ($validationFunction)
 
 getValidationCallback ()
 
 getOptions ()
 

Protected Member Functions

 formatValue ($value, IParam $param, array &$definitions, array $params)
 
- Protected Member Functions inherited from ParamProcessor\ParamDefinition
 postConstruct ()
 
 formatList (IParam $param, array &$definitions, array $params)
 
 formatValue ($value, IParam $param, array &$definitions, array $params)
 

Protected Attributes

 $toLower = false
 
- Protected Attributes inherited from ParamProcessor\ParamDefinition
 $trimValue = null
 
 $applyManipulationsToDefault = true
 
 $dependencies = []
 
 $default
 
 $name
 
 $isList
 
 $delimiter = ','
 
 $aliases = []
 
 $message = 'validator-message-nodesc'
 
 $options = []
 
 $parser = null
 
 $validator = null
 
 $validationFunction = null
 
 $type
 

Additional Inherited Members

- Static Public Member Functions inherited from ParamProcessor\ParamDefinition
static getCleanDefinitions (array $definitions)
 
- Static Public Attributes inherited from ParamProcessor\ParamDefinition
static $acceptOverriding = false
 
static $accumulateParameterErrors = false
 

Detailed Description

Defines the string parameter type. Specifies the type specific validation and formatting logic.

Since
1.0

GNU GPL v2+

Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

ParamProcessor\Definition\StringParam::formatValue (   $value,
IParam  $param,
array &  $definitions,
array  $params 
)
protected

Formats the parameter value to it's final result.

See Also
ParamDefinition::formatValue
Since
1.0
Parameters
$valuemixed
$paramIParam
$definitionsarray of IParamDefinition
$paramsarray of IParam
Returns
mixed
ParamProcessor\Definition\StringParam::setArrayValues ( array  $param)

Sets the parameter definition values contained in the provided array.

See Also
ParamDefinition::setArrayValues
Since
1.0
Parameters
array$param

Implements ParamProcessor\IParamDefinition.

ParamProcessor\Definition\StringParam::setToLower (   $toLower)

Sets of the value should be lowercased.

Since
1.0
Parameters
boolean$toLower

The documentation for this class was generated from the following file: