This package configures Slim 3 to work with the PHP-DI container.
The most obvious difference with the default Slim installation is that you will be using PHP-DI as the container, which has the following benefits:
- autowiring
- powerful configuration format
- support for modular systems
- ...
If you want to learn more about all that PHP-DI can offer have a look at its introduction.
While you controllers can be simple closures, you can also write them as classes and have PHP-DI instantiate them only when they are called:
class UserController
{
private $userRepository;
public function __construct(UserRepository $userRepository)
{
$this->userRepository = $userRepository;
}
public function delete($request, $response)
{
$this->userRepository->remove($request->getAttribute('id'));
$response->getBody()->write('User deleted');
return $response;
}
}
$app->delete('/user/{id}', ['UserController', 'delete']);
Dependencies can then be injected in your controller using autowiring, PHP-DI config files or even annotations.
By default, Slim controllers have a strict signature: $request, $response, $args
. The PHP-DI bridge offers a more flexible and developer friendly alternative.
Controller parameters can be any of these things:
- request or response injection (parameters must be named
$request
or$response
) - request attribute injection
- service injection (by type-hint)
You can mix all these types of parameters together too. They will be matched by priority in the order of the list above.
You can inject the request or response in the controller parameters by name:
$app->get('/', function (ResponseInterface $response, ServerRequestInterface $request) {
// ...
});
As you can see, the order of the parameters doesn't matter. That allows to skip injecting the $request
if it's not needed for example.
$app->get('/hello/{name}', function ($name, ResponseInterface $response) {
$response->getBody()->write('Hello ' . $name);
return $response;
});
As you can see above, the route's URL contains a name
placeholder. By simply adding a parameter with the same name to the controller, PHP-DI will directly inject it.
To inject services into your controllers, you can write them as classes. But if you want to write a micro-application using closures, you don't have to give up dependency injection either.
You can inject services by type-hinting them:
$app->get('/', function (ResponseInterface $response, Twig $twig) {
return $twig->render($response, 'home.twig');
});
Note: you can only inject services that you can type-hint and that PHP-DI can provide. Type-hint injection is simple, it simply injects the result of
$container->get(/* the type-hinted class */)
.
composer require php-di/slim-bridge
Instead of using Slim\App
, simply use DI\Bridge\Slim\App
:
<?php
require 'vendor/autoload.php';
$app = new \DI\Bridge\Slim\App;
You can then use the application just like a classic Slim application:
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
$app->get('/hello/{name}', function (Request $request, Response $response) {
$response->getBody()->write('Hello!');
return $response;
});
$app->run();
You may notice the DI\Bridge\Slim\App
class is very simple. You can very well create the container yourself and pass it to the constructor of Slim\App
. Just don't forget to register the src/config.php
file in the container.
If you want to configure PHP-DI, simply extend the DI\Bridge\Slim\App
class and override the configureContainer()
method:
class MyApp extends \DI\Bridge\Slim\App
{
protected function configureContainer(ContainerBuilder $builder)
{
$builder->addDefinitions(__DIR__ . 'my-config-file.php');
}
}
$app = new MyApp;
Or if you are using PHP 7 you can use anonymous classes:
$app = new class() extends \DI\Bridge\Slim\App {
protected function configureContainer(ContainerBuilder $builder)
{
$builder->addDefinitions(__DIR__ . 'my-config-file.php');
}
};
Have a look at configuring PHP-DI for more details.
In order to get you started easily, here is how you can install the Twig extension for Slim:
-
install the Twig-View package:
composer require slim/twig-view
-
configure the
Twig
class in PHP-DI (taken from the package's documentation):class MyApp extends \DI\Bridge\Slim\App { protected function configureContainer(ContainerBuilder $builder) { $definitions = [ \Slim\Views\Twig::class => function (ContainerInterface $c) { $twig = new \Slim\Views\Twig('path/to/templates', [ 'cache' => 'path/to/cache' ]); $twig->addExtension(new \Slim\Views\TwigExtension( $c->get('router'), $c->get('request')->getUri() )); return $twig; }, ]; $builder->addDefinitions($definitions); } }
You can now inject the service in your controllers and render templates:
$app->get('/', function ($response, Twig $twig) {
return $twig->render($response, 'home.twig');
});