ecphp/php-directive-bundle

Let users customize the PHP directives through a custom ini file.

1.0.1 2021-07-05 14:23 UTC

This package is auto-updated.

Last update: 2024-10-28 01:36:14 UTC


README

Latest Stable Version GitHub stars Total Downloads GitHub Workflow Status Scrutinizer code quality Type Coverage Code Coverage License

PHP Directive Bundle

Description

This bundle for Symfony 5 let users alter and customize their PHP configuration through directives.

Usually the PHP configuration lives in a system wide php.ini file and most of the time regular users do not have the permissions to alter it.

This bundle fix this by providing an easy way to alter the PHP configuration through a .ini file, file that can then be committed in the project repository.

Installation

composer require ecphp/php-directive-bundle

Usage

Create a new Symfony configuration file in config/packages/php-directive-bundle.yaml as such:

php_directive:
  user_ini_file: "%env(resolve:USER_INI_FILE)%"

Then add a new environment variable in the appropriate .env file of your choice:

USER_INI_FILE=php.user.ini

Then create a php.user.ini file in your project directory, containing some custom directives:

memory_limit=512M
max_execution_time=120
SMTP=smtp.example.com
date.timezone="Europe/Brussels"
xdebug.mode=debug

Documentation

Find all the available PHP directives on the official PHP website.

Code quality, tests, benchmarks

Every time changes are introduced into the library, Github runs the tests.

The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.

Before each commit, some inspections are executed with GrumPHP; run composer grumphp to check manually.

The quality of the tests is tested with Infection a PHP Mutation testing framework, run composer infection to try it.

Static analyzers are also controlling the code. PHPStan and PSalm are enabled to their maximum level.

Contributing

Changelog

See CHANGELOG.md for a changelog based on git commits.

For more detailed changelogs, please check the release changelogs.