PhpTailors Libraries

General-purpose libraries from PhpTailors.

Online documentation

TODO: link to the online documentation

Notes for users

Runtime Requirements

PHP>=8.0 is required.

Notes for developers

Development requirements

• docker
• composer

Initial preparations

After you've just cloned

php scripts/bootstrap-dev
composer up
composer bin all up
php docker/initialize

Running all tests

composer tests

Running unit tests

composer phpunit

or (with docker-compose)

docker/php run --rm php vendor/bin/phpunit

Running sphinx examples tests

composer doctests

or (with docker-compose)

docker/php run --rm php vendor-bin/behat/vendor/bin/behat -c docs/behat.yml

Running interactive PHP shell

composer psysh

or (with docker-compose)

docker/php run --rm php vendor-bin/psysh/vendor/bin/psysh vendor/autoload.php

Running CodeClimate

docker/codeclimate run --rm codeclimate analyze

Generating API documentation

docker/docs run --rm sami build

The generated API docs go to docs/build/html/api/.

Generating API documentation continuously and serving via HTTP

docker/docs up sami

The generated API docs go to docs/build/html/api/ and get exposed at

• https://localhost:8001.

Generating sphinx documentation continuously and serving via HTTP

docker/docs up sphinx

The generated docs go to docs/build/html and get exposed at

• http://localhost:8002.