BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
DPL\ParametersData Class Reference
Inheritance diagram for DPL\ParametersData:

Public Member Functions

 __construct ()
 
 exists ($parameter)
 
 getData ($parameter)
 
 setRichness ($level)
 
 getRichness ()
 
 testRichness ($function)
 
 getParametersForRichness ($level=null)
 
 getDefault ($parameter)
 
 getValues ($parameter)
 
 setsCriteriaFound ($parameter)
 
 isOpenReferenceConflict ($parameter)
 
 shouldPreserveCase ($parameter)
 
 isPageNameList ($parameter)
 
 isBoolean ($parameter)
 
 isTimestamp ($parameter)
 

Constructor & Destructor Documentation

DPL\ParametersData::__construct ( )

Main Constructor

public

Returns
void

Member Function Documentation

DPL\ParametersData::exists (   $parameter)

Return if the parameter exists.

public

Parameters
stringParameter name.
Returns
boolean Exists
DPL\ParametersData::getData (   $parameter)

Return data for the supplied parameter.

public

Parameters
stringParameter name.
Returns
mixed Parameter array or false if it does not exist.
DPL\ParametersData::getDefault (   $parameter)

Return the default value for the parameter.

public

Parameters
stringParameter Name
Returns
mixed
DPL\ParametersData::getParametersForRichness (   $level = null)

Returns all parameters for the current richness level or limited to the optional maximum richness.

public

Parameters
integer[Optional] Maximum richness level
Returns
array The functional richness parameters list.
DPL\ParametersData::getRichness ( )

Returns the current parameter richness.

public

Returns
integer
DPL\ParametersData::getValues (   $parameter)

Return the acceptable values for the parameter.

public

Parameters
stringParameter Name
Returns
mixed Array of allowed values or false that the parameter allows any.
DPL\ParametersData::isBoolean (   $parameter)

Is the parameter supposed to be parsed as a boolean?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::isOpenReferenceConflict (   $parameter)

Does the parameter cause an open reference conflict?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::isPageNameList (   $parameter)

Does this parameter take a list of page names?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::isTimestamp (   $parameter)

Is the parameter supposed to be parsed as a Mediawiki timestamp?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::setRichness (   $level)

Sets the current parameter richness.

public

Parameters
integerInteger level.
Returns
void
DPL\ParametersData::setsCriteriaFound (   $parameter)

Does the parameter set that criteria for selection was found?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::shouldPreserveCase (   $parameter)

Should this parameter preserve the case of the user supplied input?

public

Parameters
stringParameter Name
Returns
boolean
DPL\ParametersData::testRichness (   $function)

Tests if the function is valid for the current functional richness level.

public

Parameters
stringFunction to test.
Returns
boolean Valid for this functional richness level.

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