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

Public Member Functions

 __construct ()
 
 __call ($parameter, $arguments)
 
 sortByPriority ($parameters)
 
 isSelectionCriteriaFound ()
 
 isOpenReferencesConflict ()
 
 setParameter ($parameter, $option)
 
 getParameter ($parameter)
 
 getAllParameters ()
 
 filterBoolean ($boolean)
 
 _category ($option)
 
 _categoryregexp ($option)
 
 _categorymatch ($option)
 
 _notcategory ($option)
 
 _notcategoryregexp ($option)
 
 _notcategorymatch ($option)
 
 _count ($option)
 
 _namespace ($option)
 
 _notnamespace ($option)
 
 _openreferences ($option)
 
 _ordermethod ($option)
 
 _mode ($option)
 
 _distinct ($option)
 
 _ordercollation ($option)
 
 _listseparators ()
 
 _format ($option)
 
 _title ($option)
 
 _titleregexp ($option)
 
 _titlematch ($option)
 
 _nottitleregexp ($option)
 
 _nottitlematch ($option)
 
 _scroll ($option)
 
 _replaceintitle ($option)
 
 _debug ($option)
 
 _includepage ()
 
 _include ($option)
 
 _includematch ($option)
 
 _includematchparsed ($option)
 
 _includenotmatch ($option)
 
 _includenotmatchparsed ($option)
 
 _secseparators ($option)
 
 _multisecseparators ($option)
 
 _table ($option)
 
 _tablerow ($option)
 
 _allowcachedresults ($option)
 
 _fixcategory ($option)
 
 _reset ($option)
 
 _eliminate ($option)
 
- Public Member Functions inherited from DPL\ParametersData
 __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\Parameters::__construct ( )

Main Constructor

public

Returns
void

Member Function Documentation

DPL\Parameters::__call (   $parameter,
  $arguments 
)

Handle simple parameter functions.

public

Parameters
stringFunction(Parameter) Called
stringFunction Arguments
Returns
boolean Successful
DPL\Parameters::_allowcachedresults (   $option)

Clean and test 'allowcachedresults' parameter. This function is necessary for the custom 'yes+warn' option that sets 'warncachedresults'.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_category (   $option)

Clean and test 'category' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_categorymatch (   $option)

Clean and test 'categorymatch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_categoryregexp (   $option)

Clean and test 'categoryregexp' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_count (   $option)

Clean and test 'count' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_debug (   $option)

Clean and test 'debug' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_distinct (   $option)

Clean and test 'distinct' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_eliminate (   $option)

Clean and test 'eliminate' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_fixcategory (   $option)

Clean and test 'fixcategory' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_format (   $option)

Clean and test 'format' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_include (   $option)

Clean and test 'include' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_includematch (   $option)

Clean and test 'includematch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_includematchparsed (   $option)

Clean and test 'includematchparsed' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_includenotmatch (   $option)

Clean and test 'includenotmatch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_includenotmatchparsed (   $option)

Clean and test 'includenotmatchparsed' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_includepage ( )

Short cut to _include();

public

Returns
mixed
DPL\Parameters::_listseparators ( )

Short cut to _format();

public

Returns
mixed
DPL\Parameters::_mode (   $option)

Clean and test 'mode' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_multisecseparators (   $option)

Clean and test 'multisecseparators' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_namespace (   $option)

Clean and test 'namespace' parameter.

public

Parameters
stringOption passed to parameter.
Returns
boolean Success
DPL\Parameters::_notcategory (   $option)

Clean and test 'notcategory' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_notcategorymatch (   $option)

Clean and test 'notcategorymatch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_notcategoryregexp (   $option)

Clean and test 'notcategoryregexp' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_notnamespace (   $option)

Clean and test 'notnamespace' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_nottitlematch (   $option)

Clean and test 'nottitlematch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_nottitleregexp (   $option)

Clean and test 'nottitleregexp' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_openreferences (   $option)

Clean and test 'openreferences' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_ordercollation (   $option)

Clean and test 'ordercollation' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_ordermethod (   $option)

Clean and test 'ordermethod' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_replaceintitle (   $option)

Clean and test 'replaceintitle' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_reset (   $option)

Clean and test 'reset' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_scroll (   $option)

Clean and test 'scroll' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_secseparators (   $option)

Clean and test 'secseparators' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_table (   $option)

Clean and test 'table' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_tablerow (   $option)

Clean and test 'tablerow' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_title (   $option)

Clean and test 'title' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_titlematch (   $option)

Clean and test 'titlematch' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::_titleregexp (   $option)

Clean and test 'titleregexp' parameter.

public

Parameters
stringOptions passed to parameter.
Returns
boolean Success
DPL\Parameters::filterBoolean (   $boolean)

Filter a standard boolean like value into an actual boolean.

public

Parameters
mixedInteger or string to evaluated through filter_var().
Returns
boolean
DPL\Parameters::getAllParameters ( )

Get all parameters.

public

Returns
array Parameter => Options
DPL\Parameters::getParameter (   $parameter)

Get a parameter's option.

public

Parameters
stringParameter to get
Returns
mixed Option for specified parameter.
DPL\Parameters::isOpenReferencesConflict ( )

Get Open References Conflict - See 'openreferences' parameter.

public

Returns
boolean Is Conflict?
DPL\Parameters::isSelectionCriteriaFound ( )

Get Selection Criteria Found

public

Returns
boolean Is Conflict?
DPL\Parameters::setParameter (   $parameter,
  $option 
)

Set a parameter's option.

public

Parameters
stringParameter to set
mixedOption to set
Returns
void
DPL\Parameters::sortByPriority (   $parameters)

Sort cleaned parameter arrays by priority. Users can not be told to put the parameters into a specific order each time. Some parameters are dependent on each other coming in a certain order due to some procedural legacy issues.

public

Parameters
arrayUnsorted Parameters
Returns
array Sorted Parameters

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