PHPackages                             mwstake/mediawiki-component-inputprocessor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mwstake/mediawiki-component-inputprocessor

ActiveLibrary[Utility & Helpers](/categories/utility)

mwstake/mediawiki-component-inputprocessor
==========================================

Provides a simple framework for processing user input

1.1.4(6mo ago)08.2k↑40.9%[1 PRs](https://github.com/hallowelt/mwstake-mediawiki-component-inputprocessor/pulls)1GPL-3.0-onlyPHPCI passing

Since Sep 13Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/hallowelt/mwstake-mediawiki-component-inputprocessor)[ Packagist](https://packagist.org/packages/mwstake/mediawiki-component-inputprocessor)[ RSS](/packages/mwstake-mediawiki-component-inputprocessor/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (6)Versions (15)Used By (1)

MediaWiki Stakeholders Group - Components
=========================================

[](#mediawiki-stakeholders-group---components)

InputProcessor for MediaWiki
============================

[](#inputprocessor-for-mediawiki)

Provides a simple framework for processing user input, e.g. from tags, parserfunctions, API paramters, etc.

**This code is meant to be executed within the MediaWiki application context. No standalone usage is intended.**

Compatibility
-------------

[](#compatibility)

- `1.0.x` -> MediaWiki 1.43

Use in a MediaWiki extension
----------------------------

[](#use-in-a-mediawiki-extension)

Require this component in the `composer.json` of your extension:

```
{
	"require": {
		"mwstake/mediawiki-component-inputprocessor": "~1"
	}
}
```

Usage
-----

[](#usage)

Note: See `phpunit` tests for useful examples

### Define processors

[](#define-processors)

Processors are defined as an assoc array where keys match the field names passed as input and values are instances of MWStake\\MediaWiki\\Component\\InputProcessor\\IProcessor interface.

Ways to create processors:

- Directly create an instance of a processor class

```
$intProcessor = new MWStake\MediaWiki\Component\InputProcessor\IntValue();
$intProcessor
    ->setRequired( true )
    ->setMin( 0 )
    ->setMax( 999 );

$processors = [
    'myNumber' => $intProcessor,
    'myNumber2' => $intProcessor
];
```

- Use a factory to create an instance of a processor class. Useful for more complex processors, requiring more ctor params

```
$factory = MediaWiki\MediaWikiServices::getInstance()->getService( 'MWStake.InputProcessor.Factory' );
// Either pass configuration directly
$titleProcessor = $factory->createWithData( 'title', [ 'required' => true, 'allowedNamespace' => [ NS_MAIN, NS_USER ] ] );
// Or perform configuration on an instance
$titleProcessor = $factory->create( 'title' );
$titleProcessor
    ->setRequired( true )
    ->setAllowedNamespace( [ NS_MAIN, NS_USER ] );

$processors = [
       ...
    'myPage' => $titleProcessor,
    ....
];
```

- Use static configuration

```
$processors = [
    'myPage' => [
        'type' => 'title',
        'required' => true,
        'allowedNamespaces' => [ NS_MAIN, NS_USER ]
    ],
    'myNumber' => [
        'type' => 'int',
        'required' => true,
        'min' => 0,
        'max' => 999
    ]
]
```

Full example

```
$factory = MediaWiki\MediaWikiServices::getInstance()->getService( 'MWStake.InputProcessor.Factory' );
$namespaceListProcessor = $factory->create( 'namespace-list' );
$namespaceListProcessor
    ->setRequired( true )
    ->setListSeparator( '|' );

$intProcessor = $factory->create( 'integer' );
$intProcessor
    ->setRequired( true )
    ->setMin( 0 )
    ->setMax( 999 );

$processors = [
    'source-namespaces' => $namespaceListProcessor,
    'count' => $intProcessor,
    'label' => [
        'type' => 'string',
        'required' => false,
    ]
];

// User provided input
$input = [
	'source-namespaces' => '0|Help|User|Foo',
	'count' => '5',
	'label' => 'My label'
];

// Process input
$runner = MediaWiki\MediaWikiServices::getInstance()->getService( 'MWStake.InputProcessor' );
$status = $runner->process( $processors, $input );
if ( $status->isGood() ) {
    print_r( $status->getValue() );
    /*
	 * [
	 *     'source-namespaces' => [ 0, 12, 2, 1204 ],
	 *     'count' => 5,
	 *     'label' => 'My label'
	 * ]
	 */
} else {
    $errors = $status->getErrors();
    foreach ( $errors as $error ) {
        $msg = \Message::newFromKey( $error['message'] )->params( ...$error['params'] );
        $errorText = $msg->plain();
        // Display error
    }
}
```

### Register new processor types

[](#register-new-processor-types)

```
// Over config var
$GLOBALS['mwsgInputProcessorRegistry']['my-processor'] = {OF_SPEC};

$GLOBALS['wgHooks']['MWStakeInputProcessorRegisterProcessors'][] = function( &$types ) {
    $types['my-processor'] = {OF_SPEC};
};
```

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance68

Regular maintenance activity

Popularity25

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~34 days

Recently: every ~39 days

Total

13

Last Release

203d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/161c38b5448b71865cf0652b6974ed489dd3683b5d6e1814973cea6cb66c8f1d?d=identicon)[dsavuljesku](/maintainers/dsavuljesku)

---

Top Contributors

[![HamishSlater](https://avatars.githubusercontent.com/u/26261210?v=4)](https://github.com/HamishSlater "HamishSlater (13 commits)")[![it-spiderman](https://avatars.githubusercontent.com/u/13665198?v=4)](https://github.com/it-spiderman "it-spiderman (11 commits)")[![osnard](https://avatars.githubusercontent.com/u/1201528?v=4)](https://github.com/osnard "osnard (3 commits)")

### Embed Badge

![Health badge](/badges/mwstake-mediawiki-component-inputprocessor/health.svg)

```
[![Health](https://phpackages.com/badges/mwstake-mediawiki-component-inputprocessor/health.svg)](https://phpackages.com/packages/mwstake-mediawiki-component-inputprocessor)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)