markroland / url-shortener-lib

URL Shortener PHP Library

URL Shortener Library

This is a library to manage database storage of short URLs

Copyright 2017 Mark Roland.
Released under the MIT license.

TODO:

• Write unit tests
• Test build processes (phpunit, phpcs, phpdoc, build.xml)

Installation

    composer require markroland/url-shortener-lib

Build

Build using Phing

    phing

    phing phpdoc

    phing phpcs

PHPUnit

    phpunit --bootstrap tests/bootstrap.php tests

Code Coverage

    phpunit --coverage-html ./report ./tests

PHP Documentation

PHP Documentation is compiled using phpDocumentor, which is assumed to be installed globally on the server. It uses phpdoc.dist.xml for runtime configuration.

    phpdoc

Code Sniff

    phpcs -n --report-width=100 ./src