If you are upgrading from version 2 to version 3, these are the significant changes that you need to be aware of.
Slim 3 requires PHP 5.5+
Slim 3 uses \Slim\App for the Application object usually named $app.
$app = new \Slim\App();
$app->get('/', function (Request $req, Response $res, $args = []) {
return $res->withStatus(400)->write('Bad Request');
});
As mentioned above, Slim 3 passes the Request and Response objects as arguments to the route handling function. Since they are now accessible directly in the body of a route function, request and response are no longer properties of the /Slim/App (Application object) instance.
$app->get('/', function (Request $req, Response $res, $args = []) {
$myvar1 = $req->getParam('myvar'); //checks both _GET and _POST [NOT PSR-7 Compliant]
$myvar2 = $req->getParsedBody()['myvar']; //checks _POST [IS PSR-7 compliant]
$myvar3 = $req->getQueryParams()['myvar']; //checks _GET [IS PSR-7 compliant]
});
Hooks are no longer part of Slim as of v3. You should consider reimplementing any functionality associated with the default hooks in Slim v2 as middleware instead. If you need the ability to apply custom hooks at arbitrary points in your code (for example, within a route), you should consider a third-party package such as Symfony’s EventDispatcher or Zend Framework’s EventManager.
In Slim v3 we have removed the HTTP-Caching into its own module Slim\Http\Cache.
Slim Core has removed Stop/Halt. In your applications, you should transition to using the withStatus() and withBody() methods.
Slim::registerAutoloader() have been removed, we have fully moved to composer.
$app->container->singleton(...) is now $container = $app->getContainer(); $container['...'] = function () {}; Please read Pimple docs for more info
$app->configureMode(...) has been removed in v3.
PrettyExceptions cause lots of issues for many people, so these have been removed.
We have switched routers which enable you to keep the default conditions regex inside the route pattern.
In Slim v2.x one would use the helper function $app->redirect(); to trigger a redirect request.
In Slim v3.x one can do the same with using the Response class like so.
Example:
$app->get('/', function ($req, $res, $args) {
return $res->withStatus(302)->withHeader('Location', 'your-new-uri');
});
Alternatively, if you want a route to redirect without any other handling, you
can use the shortcut helper function $app->redirect() as the route
definition:
$app->redirect('/', 'your-new-uri');
The middleware signature has changed from a class to a function.
New signature:
use Psr\Http\Message\RequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
$app->add(function (Request $req, Response $res, callable $next) {
// Do stuff before passing along
$newResponse = $next($req, $res);
// Do stuff after route is rendered
return $newResponse; // continue
});
You can still use a class:
namespace My;
use Psr\Http\Message\RequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
class Middleware
{
function __invoke(Request $req, Response $res, callable $next) {
// Do stuff before passing along
$newResponse = $next($req, $res);
// Do stuff after route is rendered
return $newResponse; // continue
}
}
// Register
$app->add(new My\Middleware());
// or
$app->add(My\Middleware::class);
Application middleware is executed as Last In First Executed (LIFE).
Flash messages are no longer a part of the Slim v3 core but instead have been moved to separate Slim Flash package.
In v3.0 cookies has been removed from core. See FIG Cookies for a PSR-7 compatible cookie component.
In v3.0 we have removed the dependency for crypto in core.
Slim now utilizes FastRoute, a new, more powerful router!
This means that the specification of route patterns has changed with named parameters now in braces and square brackets used for optional segments:
// named parameter:
$app->get('/hello/{name}', /*...*/);
// optional segment:
$app->get('/news[/{year}]', /*...*/);
The syntax for adding route middleware has changed slightly. In v3.0:
$app->get(…)->add($mw2)->add($mw1);
The route is an attribute of the Request object in v3.0:
$request->getAttribute('route');
When getting the current route in middleware, the value for
determineRouteBeforeAppMiddleware must be set to true in the Application
configuration, otherwise the getAttribute call returns null.
urlFor() has been renamed pathFor() and can be found in the router object:
$app->get('/', function ($request, $response, $args) {
$url = $this->router->pathFor('home');
$response->write("<a href='$url'>Home</a>");
return $response;
})->setName('home');
Also, pathFor() is base path aware.
Slim uses Pimple as a Dependency Injection Container.
// index.php
$app = new Slim\App(
new \Slim\Container(
include '../config/container.config.php'
)
);
// Slim will grab the Home class from the container defined below and execute its index method.
// If the class is not defined in the container Slim will still construct it and pass the container as the first argument to the constructor!
$app->get('/', Home::class . ':index');
// In container.config.php
// We are using the SlimTwig here
return [
'settings' => [
'viewTemplatesDirectory' => '../templates',
],
'twig' => [
'title' => '',
'description' => '',
'author' => ''
],
'view' => function ($c) {
$view = new Twig(
$c['settings']['viewTemplatesDirectory'],
[
'cache' => false // '../cache'
]
);
// Instantiate and add Slim specific extension
$view->addExtension(
new TwigExtension(
$c['router'],
$c['request']->getUri()
)
);
foreach ($c['twig'] as $name => $value) {
$view->getEnvironment()->addGlobal($name, $value);
}
return $view;
},
Home::class => function ($c) {
return new Home($c['view']);
}
];
This means that when you change one of these objects, the old instance is not updated.
// This is WRONG. The change will not pass through.
$app->add(function (Request $request, Response $response, $next) {
$request->withAttribute('abc', 'def');
return $next($request, $response);
});
// This is correct.
$app->add(function (Request $request, Response $response, $next) {
$request = $request->withAttribute('abc', 'def');
return $next($request, $response);
});
// ...
$image = __DIR__ . '/huge_photo.jpg';
$body = new Stream($image);
$response = (new Response())
->withStatus(200, 'OK')
->withHeader('Content-Type', 'image/jpeg')
->withHeader('Content-Length', filesize($image))
->withBody($body);
// ...
For text:
// ...
$response = (new Response())->getBody()->write('Hello world!')
// Or Slim specific: Not PSR-7 compliant.
$response = (new Response())->write('Hello world!');
// ...