Создаем собственный фреймворк на основе Symfony2. (Часть 5) перевод

В пятой части серии мы поговорим о контроллерах.

• Часть 1
• Часть 2
• Часть 3
• Часть 4
• Часть 5
• Часть 6

Внимательный читатель заметил, что в нашем фреймворке жестко прописан способ, которым выполняется код шаблонов. Для простых страниц, как те, которые мы создавали ранее, — это не проблема. Но если вы планируете добавить больше логики, вам придется внедрить её в сам шаблон.

Что, естественно, не очень хорошая идея, особенно если вы хотели разделить систему на отдельные функциональные структуры.
Давайте отделим код шаблона от логики, добавив новый слой — контроллер: «Задача контроллера заключается в создании Ответа на основе информации, переданной по Запросу клиента.»
Изменим часть шаблона, отвечающую за рендеринг, следующим образом:

<?php
 
// example.com/web/front.php
 
// ...
 
try {
    $request->attributes->add($matcher->match($request->getPathInfo()));
    $response = call_user_func('render_template', $request);
} catch (Routing\Exception\ResourceNotFoundException $e) {
    $response = new Response('Not Found', 404);
} catch (Exception $e) {
    $response = new Response('An error occurred', 500);
}

Поскольку рендеринг теперь выполнен внешней функцией render_template(), мы должны передать ей атрибуты извлеченные из URL. Мы могли бы передать их в качестве дополнительного аргумента в render_template(), но вместо этого мы используем еще одну особенность класса Запросов (Request class) – атрибуты. Атрибуты Запроса позволяют включать дополнительную информацию о Запросе, которая непосредственно не связана с данными HTTP-запроса.
Теперь напишем функцию render_template(), общий контроллер, который рендерит шаблон, без особой логики. Чтобы сохранить прежнюю структуру шаблона, атрибуты запроса извлекаются до рендера шаблона:

function render_template($request)
{
    extract($request->attributes->all(), EXTR_SKIP);
    ob_start();
    include sprintf(__DIR__.'/../src/pages/%s.php', $_route);
 
    return new Response(ob_get_clean());
}

Так как render_template используется как аргумент для PHP call_user_func(), мы можем заменить его любой допустимой PHP callback-функцией. Это позволит использовать функцию, анонимную функцию или метод класса контроллера… на ваш выбор.
Для стандартизации определения любого пути, связанный контроллер сконфигурирован через атрибут маршрута _controller:

$routes->add('hello', new Routing\Route('/hello/{name}', array(
    'name' => 'World',
    '_controller' => 'render_template',
)));
 
try {
    $request->attributes->add($matcher->match($request->getPathInfo()));
    $response = call_user_func($request->attributes->get('_controller'), $request);
} catch (Routing\Exception\ResourceNotFoundException $e) {
    $response = new Response('Not Found', 404);
} catch (Exception $e) {
    $response = new Response('An error occurred', 500);
}

Маршрут теперь может быть связан с любым контроллером и, конечно, в контроллере, вы можете использовать render_template(), чтобы рендерить шаблон:

$routes->add('hello', new Routing\Route('/hello/{name}', array(
    'name' => 'World',
    '_controller' => function ($request) {
        return render_template($request);
    }
)));

Это более гибко, так как вы можете менять объект Ответа (Response object), и вы даже можете передать дополнительные аргументы в шаблон:

$routes->add('hello', new Routing\Route('/hello/{name}', array(
    'name' => 'World',
    '_controller' => function ($request) {
        // $foo will be available in the template
        $request->attributes->set('foo', 'bar');
 
        $response = render_template($request);
 
        // change some header
        $response->headers->set('Content-Type', 'text/plain');
 
        return $response;
    }
)));

Вот обновленная и улучшенная версия нашей системы:

<?php
 
// example.com/web/front.php
 
require_once __DIR__.'/../vendor/.composer/autoload.php';
 
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing;
 
function render_template($request)
{
    extract($request->attributes->all(), EXTR_SKIP);
    ob_start();
    include sprintf(__DIR__.'/../src/pages/%s.php', $_route);
 
    return new Response(ob_get_clean());
}
 
$request = Request::createFromGlobals();
$routes = include __DIR__.'/../src/app.php';
 
$context = new Routing\RequestContext();
$context->fromRequest($request);
$matcher = new Routing\Matcher\UrlMatcher($routes, $context);
 
try {
    $request->attributes->add($matcher->match($request->getPathInfo()));
    $response = call_user_func($request->attributes->get('_controller'), $request);
} catch (Routing\Exception\ResourceNotFoundException $e) {
    $response = new Response('Not Found', 404);
} catch (Exception $e) {
    $response = new Response('An error occurred', 500);
}
 
$response->send();

В честь дня рождения нашего фреймворка, давайте создадим новое приложение с простейшей логикой. Наше приложение состоит из одной страницы, которая говорит: является ли данный год високосным или нет. При вызове /is_leap_year, вы получите ответ для текущего года, но вы также можете указать год, в виде /is_leap_year/2009. Будучи универсальным, фреймворк не нуждается в изменениях, просто создадим новый файл app.php:

<?php
 
// example.com/src/app.php
 
use Symfony\Component\Routing;
use Symfony\Component\HttpFoundation\Response;
 
function is_leap_year($year = null) {
    if (null === $year) {
        $year = date('Y');
    }
 
    return 0 == $year % 400 || (0 == $year % 4 && 0 != $year % 100);
}
 
$routes = new Routing\RouteCollection();
$routes->add('leap_year', new Routing\Route('/is_leap_year/{year}', array(
    'year' => null,
    '_controller' => function ($request) {
        if (is_leap_year($request->attributes->get('year'))) {
            return new Response('Yep, this is a leap year!');
        }
 
        return new Response('Nope, this is not a leap year.');
    }
)));
 
return $routes;

Is_leap_year () возвращает true, если данный год является високосным, false в противном случае. Если год null, то проверяется текущий год. Контроллер прост: он получает год из атрибутов запроса, передает его в is_leap_year(), и в соответствии с возвращаемым значением, он создает новый объект Response.
Как всегда, вы можете решить остановиться на достигнутом и использовать фреймворк как есть. Этого, пожалуй, хватит для создания простых одностраничных сайтов и даже возможно с двумя страницами и больше.