README

This is a PHP 7 Composer compatible library for providing an annotation based hydration facility.

WARNING

This code is currently ALPHA standard - it has had limited testing and is still under active development.

UNIT TESTS ARE CURRENTLY BROKEN.

Standards

The following PHP FIG standards should be followed:

• PSR 1 - Basic Coding Standard
• PSR 2 - Coding Style Guide
• PSR 3 - Logger Interface
• PSR 4 - Autoloading Standard
• PSR 5 - PHPDoc Standard - (still in draft)
• PSR 12 - Extended Coding Style Guide - (still in draft)

Standards Checking

PHP Code Sniffer highlights potential coding standards issues.

vendor/bin/phpcs

PHP CS will use the configuration in phpcs.xml.dist by default.

To see which sniffs are running add "-s"

Unit Tests

PHPUnit is installed for unit testing (tests are in tests)

To run unit tests: vendor/bin/phpunit

For a list of the tests that have ran: vendor/bin/phpunit --tap

To restrict the tests run: vendor/bin/phpunit --filter 'Cors\\Exceptions\\BadOrigin'

or just

vendor/bin/phpunit --filter 'ExceptionTest'

for all tests which have "Exception" in them and: vendor/bin/phpunit --filter '(ExceptionTest::testEverything|ExceptionTest::testStub)'

to test the two testEverything and testStub methods in the ExceptionTest class.