skyzyx / shared-utilities
Shared, re-usable classes that can be pulled into other sub-projects.
Installs: 149
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/skyzyx/shared-utilities
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: 5.*
- guzzlehttp/log-subscriber: *
- guzzlehttp/retry-subscriber: *
- monolog/monolog: ~1.9
- pimple/pimple: ~3.0
- symfony/event-dispatcher: 2.*
Requires (Dev)
- codeclimate/php-test-reporter: *@dev
- phpunit/phpcov: ~2.0
- phpunit/phpunit: ~4.3
- satooshi/php-coveralls: *@dev
This package is not auto-updated.
Last update: 2018-05-08 20:33:34 UTC
README
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
Using Composer:
composer 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