yiisoft / requirements
Requirements checker
Fund package maintenance!
Opencollective
yiisoft
Installs: 2 872
Dependents: 1
Suggesters: 0
Security: 0
Stars: 23
Watchers: 17
Forks: 6
Open Issues: 2
Requires
- php: ^7.4|^8.0
Requires (Dev)
- maglnet/composer-require-checker: ^3.8|^4.4
- phpunit/phpunit: ^9.5
- roave/infection-static-analysis-plugin: ^1.16
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.24
This package is auto-updated.
Last update: 2024-11-19 08:51:25 UTC
README
Yii Requirements Checker
The package allows to check if a certain set of defined requirements is met.
Requirements
- PHP 7.4 or higher.
General usage
Requirements checker could be used either from web or from command line. First, create requirements.php
file:
<?php require_once('vendor/yiisoft/requirements/src/RequirementsChecker.php'); use Yiisoft\Requirements\RequirementsChecker; $requirementsChecker = new RequirementsChecker; // Add here the conditions that must be verified $config = [ [ 'name' => 'PHP version', 'mandatory' => true, 'condition' => version_compare(PHP_VERSION, '7.4.0', '>='), 'by' => '<a href="https://www.yiiframework.com">Yii Framework</a>', 'memo' => 'PHP 7.4.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' => $requirementsChecker->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.' ], ]; $result = $requirementsChecker ->check($config) ->getResult(); $requirementsChecker->render(); exit($result['summary']['errors'] === 0 ? 0 : 1);
And now it could be either put to webroot or executed as:
php requirements.php
Documentation
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
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.