Shared Utilities¶
This is a package of shared utilities for PHP-based websites and CLI applications. Logging, a dependency injection container, an event dispatcher, and a number of helpful utilities are all included.
Installation¶
Add the following information to your composer.json file (if you don’t know how composer.json works, read the instructions).
{
"require": {
"skyzyx/shared-utilities": "~1.0"
}
}
Testing¶
Firstly, run composer install -o to download and install the dependencies.
You can run the tests as follows:
./vendor/bin/phpunit
API Reference¶
The API Reference is generated by a tool called phpDocumentor 2.x. You should install it locally on your system with:
cd /usr/local/bin &&
wget http://phpdoc.org/phpDocumentor.phar &&
chmod +x phpDocumentor.phar &&
mv phpDocumentor.phar phpdoc
Once it’s installed, you can generate updated documentation by running the following command in the root of the repository.
phpdoc