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.

On Packagist:

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:

{
    "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).

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.

These fields are supported:

The requires fields currently are: name and message

• 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

$paramDefintions = array();

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

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

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

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

$processor = ParamProcessor\Processor::newDefault();

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

$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] (https://semantic-mediawiki.org/) projects.

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

• Dropped dependency on DataValues Geo.

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

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

• Implemented ProcessingResult::hasFatal
• Added ProcessingResultTest

First release as standalone PHP library.

• ParamProcessor on Packagist
• ParamProcessor on TravisCI
• ParamProcessor on ScrutinizerCI
• MediaWiki extension "Validator" - a wrapper around this library for MediaWiki users