Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/symlex/di-microkernel
A dependency injection micro-kernel for bootstrapping PHP applications
https://github.com/symlex/di-microkernel
bootstrap dependency-injection di-container kernel micro-framework php-library symfony
Last synced: about 1 month ago
JSON representation
A dependency injection micro-kernel for bootstrapping PHP applications
- Host: GitHub
- URL: https://github.com/symlex/di-microkernel
- Owner: symlex
- License: mit
- Created: 2017-02-21T09:22:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-02T15:17:54.000Z (almost 6 years ago)
- Last Synced: 2024-10-12T05:44:44.166Z (3 months ago)
- Topics: bootstrap, dependency-injection, di-container, kernel, micro-framework, php-library, symfony
- Language: PHP
- Homepage: https://docs.symlex.org
- Size: 37.1 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Micro-Kernel for PHP Applications
[](https://packagist.org/packages/symlex/di-microkernel)
[](https://packagist.org/packages/symlex/di-microkernel)
[](https://codecov.io/gh/symlex/di-microkernel)
[](https://travis-ci.org/symlex/di-microkernel)
[](https://docs.symlex.org/en/latest/di-microkernel)
This library contains a micro-kernel for bootstrapping almost any PHP application, including [Silex](https://silex.symfony.com/),
[Symlex](https://github.com/symlex/symlex) (a framework stack for agile Web development based on Symfony)
and [Symfony Console](https://symfony.com/doc/current/components/console.html).
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:
```php
#!/usr/bin/env php
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](https://symfony.com/doc/current/components/dependency_injection.html) format you might know from Symfony:
```yaml
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)%'`).
Parameter | Getter method | Setter method | Default value
--------------------|-----------------------|-----------------------|------------------
app.name | getName() | setName() | 'Kernel'
app.version | getVersion() | setVersion() | '1.0'
app.environment | getEnvironment() | setEnvironment() | 'app'
app.sub_environment | getSubEnvironment() | setSubEnvironment() | 'local'
app.debug | isDebug() | setDebug() | false
app.charset | getCharset() | setCharset() | 'UTF-8'
app.path | getAppPath() | setAppPath() | './'
app.config_path | getConfigPath() | setConfigPath() | './config'
app.base_path | getBasePath() | setBasePath() | '../'
app.storage_path | getStoragePath() | setStoragePath() | '../storage'
app.log_path | getLogPath() | setLogPath() | '../storage/log'
app.cache_path | getCachePath() | setCachePath() | '../storage/cache'
app.src_path | getSrcPath() | setSrcPath() | '../src'
## Customization ##
The kernel base class can be extended to customize it for a specific purpose such as long running console applications:
```php
=7.1",
"symlex/di-microkernel": "^2.0"
}
}
```
## About ##
DIMicroKernel is maintained by [Michael Mayer](https://blog.liquidbytes.net/about/).
Feel free to send an e-mail to [[email protected]](mailto:[email protected]) if you have any questions,
need [commercial support](https://blog.liquidbytes.net/contact/) or just want to say hello.
We welcome contributions of any kind. If you have a bug or an idea, read our
[guide](CONTRIBUTING.md) before opening an issue.