Apparat object abstraction layer
Switch branches/tags
Nothing to show
Clone or download

README.md

apparat/object

Build Status Coverage Status Scrutinizer Code Quality Code Climate Documentation Status

Purpose of this module:

  1. Mapping between objects and their file resources
    • Instantiation of objects from persisted resources
    • Creation of resources from new / unpersisted objects
      • FrontMark resources for text-based objects
      • Pairs of binary and meta data resources for binary objects
    • Object publication, un-publication and re-publication
    • Object revision management
    • Object ID assignment & incrementation
    • Object localization (?)
  2. Object API
  3. Utility functions

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

Composer dependency graph

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.