symlex / di-microkernel
Micro-Kernel for PHP Applications
Installs: 4 949
Dependents: 2
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: >=7.1
- psr/container: *
- symfony/dependency-injection: ^4.0
- symfony/yaml: ^4.0
Requires (Dev)
- lastzero/test-tools: ^4.2
README
This library contains a micro-kernel for bootstrapping almost any PHP application, including Silex, Symlex (a framework stack for agile Web development based on Symfony) and Symfony Console. The kernel itself is just a few lines to set a bunch of environment parameters and create a service container instance with that.
Run an App
Creating a kernel instance and calling run()
is enough to start an application:
#!/usr/bin/env php <?php // Composer require_once 'vendor/autoload.php'; $app = new \DIMicroKernel\Kernel('console'); // Run the 'app' service defined in config/console.yml $app->run();
Configuration
YAML files located in config/
configure the application and all of it's dependencies as a service. The filename matches
the application's environment name (e.g. config/console.yml
). The configuration can additionally be modified
for sub environments such as local or production by providing a matching config file like config/console.local.yml
(see app.sub_environment
parameter). These files are in the same well documented format you might know from Symfony:
parameters: app.name: 'My App' app.version: '1.0' services: doctrine.migrations.migrate: class: Doctrine\DBAL\Migrations\Tools\Console\Command\MigrateCommand app: class: Symfony\Component\Console\Application public: true arguments: [%app.name%, %app.version%] calls: - [ add, [ "@doctrine.migrations.migrate" ] ]
This provides a uniform approach for bootstrapping Web applications like Silex\Application
,
Symlex\Application\Web
or command-line applications like Symfony\Component\Console\Application
using the same kernel.
The result is much cleaner and leaner than the usual bootstrap and configuration madness you know from many frameworks.
Parameters
The kernel sets a number of default parameters that can be used for configuring services. The default values can be
changed via setter methods of the kernel or overwritten/extended by container config files
and environment variables (e.g. url: '%env(DATABASE_URL)%'
).
Customization
The kernel base class can be extended to customize it for a specific purpose such as long running console applications:
<?php use DIMicroKernel\Kernel; class ConsoleApp extends Kernel { public function __construct($appPath, $debug = false) { parent::__construct('console', $appPath, $debug); } public function setUp() { set_time_limit(0); ini_set('memory_limit', '-1'); } }
Caching
If debug mode is turned off, the service container configuration is cached by the kernel in the directory set as cache path. You have to delete all cache files after updating the configuration. To disable caching completely, add container.cache: false
to your configuration parameters:
parameters: container.cache: false
Composer
To use this library in your project, simply run composer require symlex/di-microkernel
or
add "symlex/di-microkernel" to your composer.json file and run composer update
:
{ "require": { "php": ">=7.1", "symlex/di-microkernel": "^2.0" } }
About
DIMicroKernel is maintained by Michael Mayer. Feel free to send an e-mail to hello@symlex.org if you have any questions, need commercial support or just want to say hello. We welcome contributions of any kind. If you have a bug or an idea, read our guide before opening an issue.