Requirements checker

dev-master / 1.0.x-dev 2024-01-22 17:24 UTC



Yii Requirements Checker

The package allows to check if a certain set of defined requirements is met.

Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

General usage

Requirements checker could be used either from web or from command line. Create requirements.php:


$config = array(
        'name' => 'PHP version',
        'mandatory' => true,
        'condition' => version_compare(PHP_VERSION, '7.2.0', '>='),
        'by' => '<a href="http://www.yiiframework.com">Yii Framework</a>',
        'memo' => 'PHP 7.2.0 or higher is required.',
        'name' => 'PDO MySQL extension',
        'mandatory' => false,
        'condition' => extension_loaded('pdo_mysql'),
        'by' => 'All DB-related classes',
        'memo' => 'Required for MySQL database.',
        'name' => 'Intl extension',
        'mandatory' => false,
        'condition' => $this->checkPhpExtensionVersion('intl', '1.0.2', '>='),
        'by' => '<a href="https://secure.php.net/manual/en/book.intl.php">Internationalization</a> support',
        'memo' => 'PHP Intl extension 1.0.2 or higher is required.'

$requirementsChecker = new RequirementsChecker();

$result = $requirementsChecker
exit($result['summary']['errors'] === 0 ? 0 : 1);

Now it could be either put to webroot or executed as php requirements.php.

Note that the code above uses PHP 4. That is done on purpose so the checker could be executed in a very old setups and tell that upgrade should be done.

Unit testing

The package is tested with PHPUnit. To run tests:


Mutation testing

The package tests are checked with Infection mutation framework. To run it:


Static analysis

The code is statically analyzed with Psalm. To run static analysis:


Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack


The Yii Requirements Checker is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.