, (*1)
php-prereqcheck
Helper class to create Prerequisite Checks. It allows you to easily create a Prerequisite Check Script for your
project, e.g. matching (php) version, installed extensions, settings etc. It also allows you to write your
own checks to implement individual checks., (*2)
Features
- Simple to use API to create own prerequisite scripts / checks
- Console, Web or silent (programmatic) output
- Builtin-checks:
- php version check
- php ini settings check
- php extension checks
- PDO DB connection check
- dir writable check
- Extensible: Write your own Check classes easily
Planned features
- Output renderers to customize output
- more built-in checks like http service availability, internet access, ...
Installation using composer
Because this is a "zero" version (0.x.y), composer needs some hints to install this package:, (*3)
composer.json:, (*4)
{
"minimum-stability": "dev"
}
then:, (*5)
$ composer require bylexus/php-prereqcheck
or install it using the --dev flag:, (*6)
$ composer require --dev bylexus/php-prereqcheck
Installation without composer
Just clone the git repo:, (*7)
git clone https://github.com/bylexus/php-prereqcheck.git
Then just require the prereq-loader.php file to setup the autoloader., (*8)
Sample usage
For a working example, see example-usage.php., (*9)
# Include composer's autoload facility (recommended):
require_once('vendor/autoload.php');
# OR use the own internal autoloader, whatever fits you best:
require_once($here.'/prereq-loader.php');
$pc = new \Prereq\PrereqChecker();
# Check PHP version:
$pc->checkMandatory('php_version','>=','5.3.0');
# Check for installed PHP extensions:
$pc->checkMandatory('php_extension','gd');
$pc->checkMandatory('php_extension','mbstring');
$pc->checkMandatory('php_extension','pdo');
# Check for php.ini settings:
$pc->checkOptional('php_ini','display_errors','off','boolean');
$pc->checkOptional('php_ini','memory_limit','>=256MB','number');
$pc->checkOptional('php_ini','error_reporting',E_STRICT,'bit_enabled');
# check a php.ini string using a regular expression:
$pc->checkOptional('php_ini','date.timezone','/Europe\/.+/','string');
# Check if dir exists and is writable:
$pc->checkMandatory('dir_writable','/tmp/');
# Check if a PDO DB Connection could be established:
$pc->checkOptional('db_pdo_connection',array('dsn'=>'mysql:host=127.0.0.1','username'=>'test','password'=>'test'));
# Create own checks:
class FileExistsChecker extends \Prereq\PrereqCheck {
public function check($filename = null) {
$this->name = "File exists: {$filename}";
if (file_exists($filename)) {
$this->setSucceed();
} else {
$this->setFailed('File does not exists.');
}
}
}
$pc->registerCheck('file_exists','FileExistsChecker');
$pc->checkMandatory('file_exists','some_file.txt');
# Each check returns a CheckResult instance:
$res = $pc->checkMandatory('php_version','>=','5.3.0');
if ($res->success()) {
echo "Yes, your PHP version is compliant.";
}
# did all the checks succeed?
if ($pc->didAllSucceed()) {
echo "All tests succeeded!\n";
} else {
echo "Some tests failed. Please check.\n";
}
Built-in Checks
php_version
Checks if the actual PHP version matches a version comparison., (*10)
Example:, (*11)
$pc->checkMandatory('php_version','>=','5.3.0');
php_extension
Checks if the given PHP extension is available., (*12)
Example:, (*13)
$pc->checkMandatory('php_extension','pdo');
php_ini
Checks if a given PHP ini setting matches the criteria. Because it is not (always)
possible to determine the type of value, a comparison function is needed in the config:, (*14)
Example:, (*15)
$pc->checkOptional('php_ini','date.timezone','Europe/Zurich','string');
$pc->checkOptional('php_ini','date.timezone','/Europe\/.+/','string');
$pc->checkOptional('php_ini','display_errors','off','boolean');
$pc->checkOptional('php_ini','error_reporting',E_STRICT,'bit_enabled');
$pc->checkOptional('php_ini','error_reporting',E_NOTICE,'bit_disabled');
$pc->checkOptional('php_ini','memory_limit','>=128M','number');
Possible comparison functions:, (*16)
- boolean: Checks if the given value is true-ish or false-ish (e.g. 'Off' means false)
- string: exact string match (e.g. default_timezone = 'Europe/Zurich'). If encapsulated in '/' (e.g. /search/), the string is taken as Perl Regular Expression.
- enabled: Checks if the given bit(s) are set in the ini value (e.g. checks if E_WARNING is set in error_reporting)
- bit_disabled: Checks if the given bit(s) are NOT set in the ini value (e.g. checks if E_NOTICE is disabled in error_reporting)
- number: Checks a number value against a comparison, e.g. if memory_limit is >= 512m.
dir_writable
Checks if a given dir exists and is writable., (*17)
Example:, (*18)
$pc->checkMandatory('dir_writable','/tmp/');
db_pdo_connection
Checks if a PDO connection to a database can be established., (*19)
Example:, (*20)
$pc->checkOptional('db_pdo_connection',array('dsn'=>'mysql:host=127.0.0.1','username'=>'test','password'=>'test'));
Note:, (*21)
The options array must contain the following keys:, (*22)
- dsn: The PDO dsn
- username: The username to connect
- password. The password to use
Write your own checks
Writing your own checks is very simple. Just provide a \Prereq\PrereqCheck class and register it with the PrereqChecker.
Then you can run the defined check:, (*23)
# Define a class that extends PrereqCheck and implements the check() function:
class FileExistsChecker extends \Prereq\PrereqCheck {
public function check($filename = null) {
$this->name = "File exists: {$filename}";
if (file_exists($filename)) {
# mark check as succeed (default, don't have to be called):
$this->setSucceed();
} else {
# mark check as failed, add a failure message:
$this->setFailed('File does not exists.');
}
}
}
# Register check with the PrereqChecker:
$pc->registerCheck('file_exists','FileExistsChecker');
# Execute the check:
$pc->checkMandatory('file_exists','some_file.txt');
Prerequisite (yes, it can check itself :-) )
Version History
- 0.1.1 First release
- 0.2.0 Introduced Namespace
Prereq, and make use of the Composer autoload facility.
NOTE: This version is NO LONGER compatible with 0.1.1!
- 0.2.1 Fixes PHP ini number comparisons: -1 now counts as "unlimited" or max integer
(e.g. to support
memory_limit = -1)
Wallogit.com
