apparat/server

Purpose of this module:

1. Object access & retrieval
2. Object search
3. Object filtering
4. Object API
   • /2016/01/13/123-article/123-1 returns the article payload
   • /2016/01/13/123-article/123-1/meta returns the article meta data as YAML / JSON object
   • Could serve different formats depending on the Accept header

Documentation

Please find the project documentation in the doc directory. I recommend reading it via Read the Docs.

Installation

This library requires PHP 5.6 or later. I recommend using the latest available version of PHP as a matter of principle. It has no userland dependencies.

Dependencies

Quality

To run the unit tests at the command line, issue composer install and then phpunit at the package root. This requires Composer to be available as composer, and PHPUnit to be available as phpunit.

This library attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.