Padi PHP

A minimal library providing implementations of common design patterns and small utilities for clean architecture projects.

Installation

# Add repository
composer config repositories.christopheboucaut/padi-php git https://github.com/ChristopheBoucaut/padi-php
# Add dependency
composer require christopheboucaut/padi-php
# -- From master (add "minimum-stability": "dev" in your composer.json)
composer require christopheboucaut/padi-php:dev-master
# -- From specific version
composer require christopheboucaut/padi-php:{X.Y.Z}

How to use this library?

• English documentation
• French documentation

Contribute to the project

Installation

Requirements:

• docker
• make

Run:

• make composer-install: build docker image and install dependencies

Code quality

We use mago to format, lint, and analyze code.

• make fix: alias to run format, linter & analyze with auto fix and run linter and analyzer to show the remaining errors.
• make lint: alias to run linter.
• make analyze: alias to analyze code to detect error, etc.
• make format: alias to run format code.
• make format-check: alias to check format code.
• make mago ARGS="--help": run mago with args.

Tests

We use phpunit.

• make test: run the test suite.
• make test ARGS="tests/{path}/{file}.php": run test for a specific file or folder.
• make phpunit ARGS="--version": run phpunit with args.

Other commands

• PHP:
  • make php: interactive mode.
  • make php ARGS="-v": specific args.
• Composer:
  • make composer: without args.
  • make composer ARGS="help": specific args.
  • make composer-install: alias to install dependencies.
  • make composer-dump-autoload: alias to refresh autoload dump.