BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages

ParamProcessor is a parameter processing library that provides a way to decoratively define a set of parameters and how they should be processed. It can take such declarations together with a list of raw parameters and provide the processed values. For example, if one defines a parameter to be an integer, in the range [0, 100], then ParamProcessor will verify the input is an integer, in the specified range, and return it as an actual integer variable.

Also see ParserHooks, a library that builds on top of ParamProcessor and provides MediaWiki integration.

![Build Status]( ![Code Coverage]( ![Scrutinizer Code Quality]( ![Dependency Status](

On Packagist: ![Latest Stable Version]( ![Download count](


The recommended way to use this library is via Composer.


To add this package as a local, per-project dependency to your project, simply add a dependency on param-processor/param-processor to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a dependency on version 1.x of this package:

```json { "require": { "param-processor/param-processor": "~1.0" } } ```


Get the code of this package, either via git, or some other means. Also get all dependencies. You can find a list of the dependencies in the "require" section of the composer.json file. Then take care of autoloading the classes defined in the src directory.


The goal of the ParamProcessor library is to make parameter handling simple and consistent.

In order to achieve this, a declarative API for defining parameters is provided. Passing in such parameter definitions together with a list of raw input into the processor leads to a processed list of parameters. Processing consists out of name and alias resolving, parsing, validation, formatting and defaulting.

If ones defines an "awesomeness" parameter of type "integer", one can be sure that at the end of the processing, there will be an integer value for the awesomeness parameter. If the user did not provide a value, or provided something that is invalid, while the parameter it is required, processing will abort with a fatal error. If on the other hand there is a default, the default will be set. If the value was invalid, a warning will be kept track of. In case the user provides a valid value, for instance "42" (string), it will be turned in the appropriate 42 (int).

Implementation structure

Parameters are defined using the ParamProcessor\ParamDefinition class. Users can also use the array format to define parameters and not be bound to this class. At present, it is preferred to use this array format as the class itself is not stable yet.

Processing is done via ParamProcessor\Processor.

Defining parameters

Array definition schema

These fields are supported:

Name Type Default Description
name string required
type string (enum) string
default mixed null If this value is null, the parameter has no default and is required
aliases array of string empty array Aliases for the name
trim boolean inherited from processor options If the value should be trimmed
islist boolean false
delimiter string , The delimiter between values if it is a list
manipulatedefault boolean true If the default value should also be manipulated
values array Allowed values
message string required
post-format callback none

Takes the value as only parameter and returns the new value

The requires fields currently are: name and message

Core parameter types

Name PHP return type Description
boolean boolean Accepts "yes", "no", "on", "off", "true" and "false"
float float
integer integer
string string
coordinate DataValues
dimension string Value for a width or height attribute in HTML

Defining parameter types

  • string-parser Name of a class that implements the ValueParsers\ValueParser interface
  • validation-callback Callback that gets the raw value as only parameter and returns a boolean
  • validator Name of a class that implements the ValueValidators\ValueValidator interface


Parameter definitions

```php $paramDefinitions = array();

$paramDefinitions[] = array( 'name' => 'username', );

$paramDefinitions[] = array( 'name' => 'job', 'default' => 'unknown', 'values' => array( 'Developer', 'Designer', 'Manager', 'Tester' ), );

$paramDefinitions[] = array( 'name' => 'favourite-numbers', 'islist' => true, 'type' => 'int', 'default' => array(), ); ```


```php $inputParams = array( 'username' => 'Jeroen', 'job' => 'Developer', );

$processor = ParamProcessor::newDefault();

$processor->setParameters( $inputParams, $paramDefinitions );

$processingResult = $processor->processParameters();

$processedParams = $processingResult->getParameters(); ```


This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these tests using the PHPUnit configuration file found in the root directory. The tests can also be run via TravisCI, as a TravisCI configuration file is also provided in the root directory.



ParamProcessor has been written by Jeroen De Dauw to support the Maps and Semantic MediaWiki projects.

Release notes

1.3.3 (2017-09-28)

  • Installation together with DataValues 2.x is now allowed
  • Installation together with DataValues Common 0.4.x is now allowed

1.3.2 (2017-03-26)

  • Fixed clearing of processing errors when making multiple processing calls to one Processor instance

1.3.1 (2016-09-21)

  • Fixed ParamDefinitionFactory emitting a warning when initialized without the global wgParamDefinitions being set

1.3.0 (2016-07-15)

  • Dropped support for PHP 5.3 and PHP 5.4.
  • Fixed bug in ParamDefinition::format

1.2.5 (2016-05-23)

  • Fixed bug in Processor::newProcessingResult

1.2.4 (2016-05-15)

  • Fixed bug in ParamDefinition::getAllowedValues

1.2.3 (2016-04-04)

  • Installation together with DataValues Interfaces 0.2.x is now allowed
  • Installation together with DataValues Common 0.3.x is now allowed
  • The component is now also tested against PHP 7

1.2.2 (2014-10-24)

  • Installation together with DataValues 1.x is now allowed.

1.2.0 (2014-09-12)

  • Dropped dependency on DataValues Geo.

1.1.0 (2014-05-07)

  • Dropped dependency on DataValues Time.
  • Use PSR-4 based loading rather than PSR-0 based loading.
  • Fixed Windows compatibility in PHPUnit bootstrap

1.0.2 (2013-12-16)

  • Removed dependency on data-values/number
  • Updated required version of data-values/common from ~0.1 to ~0.2.

1.0.1 (2013-11-29)

  • Implemented ProcessingResult::hasFatal
  • Added ProcessingResultTest

1.0.0 (2013-11-21)

First release as standalone PHP library.