Контроллеры¶

Контроллер уровня приложения (AppController)¶

Как уже упоминалось во введении, класс AppController - это родительский класс для всех контроллеров вашего приложения. Сам по себе класс AppController наследуется от класса Cake\Controller\Controller, входящего в состав CakePHP. Класс AppController объявлен в файле src/Controller/AppController.php следующим образом:

namespace App\Controller;

use Cake\Controller\Controller;

class AppController extends Controller
{
}

Атрибуты и методы, прописанные в вашем классе AppController будут доступны во всех ваших контроллерах, наследующихся от данного класса. Компоненты (о которых будет рассказано далее) - это самый лучший вариант для кода, использующегося во многих (но необязательно во всех) контроллерах.

Вы можете использовать ваш AppController для загрузки компонентов, которые будут использоваться в каждом контроллере вашего приложения. CakePHP предоставляет метод initialize(), который вызывается в конце коструктора Контроллера:

namespace App\Controller;

use Cake\Controller\Controller;

class AppController extends Controller
{

    public function initialize()
    {
        // Компонент CSRF всегда включен.
        $this->loadComponent('Csrf');
    }

}

В дополнение к методу initialize(), более старое свойство $components также позволит вам объявлять обязательные к загрузке компоненты. В то время, как применяются стандартные правила наследования ООП, компоненты и хелперы, используемые контроллером обрабатываются по-особому. В данном случае значения свойств класса AppController объединяются с массивами дочерних классов контроллеров. Значения дочерних классов всегда переопределяют значения из AppController.

Поток запросов¶

Когда к приложению CakePHP делается запрос, классы CakePHP Cake\Routing\Router и Cake\Routing\Dispatcher используют Подключение маршрутов для обнаружения и создания верного экземпляра класса контроллера. Данные запроса инкапсулируются в объект запроса. CakePHP помещает всю важную информацию из запроса в свойство $this->request. Для более подробной информации об объекте запроса смотрите раздел Запрос.

Экшены контроллера¶

Экшены контроллера ответственны за преобразование параметров запроса в ответ для браузера/пользователя совершающего запрос. CakePHP использует соглашения для автоматизации данного процесса и для устранения некоторого шаблонного кода, который вам пришлось бы писать в противном случае.

По соглашению, CakePHP обрабатывает вид с именем, соответствующим имени экшена. Возвращаясь к нашему примеру онлайн пекарни, наш контроллер может содержать экшены view(), share(), и search(). Контроллер может быть найден в файле src/Controller/RecipesController.php и содержать следующий код:

// src/Controller/RecipesController.php

class RecipesController extends AppController
{
    public function view($id)
    {
        // Здесь описывается вся логика экшена.
    }

    public function share($customerId, $recipeId)
    {
        // Здесь описывается вся логика экшена.
    }

    public function search($query)
    {
        // Здесь описывается вся логика экшена.
    }
}

Файлы шаблонов для этих экшенов, назывались бы src/Template/Recipes/view.ctp, src/Template/Recipes/share.ctp, и src/Template/Recipes/search.ctp. По соглашениям имя файла вида соответствует имени экшена контроллера, записанном в нижнем регистре с использованием подчеркиваний для разделения слов.

Экшены контроллера обычно используют метод Controller::set() для создания контекста, используемого View для обработки слоя вида. Благодаря соглашениям, используемым CakePHP, вам не нужно самим создавать и обрабатывать виды. Вместо этого как только сработает экшен контроллера, CakePHP сам произведет обработку и передачу Вида.

Если по каким-либо причинам вам захочется изменить стандартное поведение, вы можете вернуть объект Cake\Http\Response из экшена с полностью созданным ответом.

Чтобы вы могли эффективно использовать контроллер в своем приложении, мы охватим некоторые основные атрибуты и методы, предоставляемые контроллерами CakePHP.

Взаимодействие с видами¶

Контроллеры взаимодействуют с видами несколькими способами. Во-первых, они способны передавать данные видам, используя метод Controller::set(). Вы также можете решить, какой класс вида использовать, какой файл вида должен быть выведен контроллером.

// Сначала передаете данные от контроллера:

$this->set('color', 'розовая');

// После этого, в виде вы можете использовать данные:
?>

Вы выбрали <?= h($color) ?> глазурь для торта.

$data = [
    'color' => 'pink',
    'type' => 'sugar',
    'base_price' => 23.95
];

// Делаем $color, $type, и $base_price
// доступными в виде:

$this->set($data);

$this->viewBuilder()
    ->helpers(['MyCustom'])
    ->theme('Modern')
    ->className('Modern.Admin');

namespace App\Controller;

class RecipesController extends AppController
{
// ...
    public function search()
    {
        // Обработка вида из src/Template/Recipes/search.ctp
        $this->render();
    }
// ...
}

// Обработка элемента из src/Template/Element/ajaxreturn.ctp
$this->render('/Element/ajaxreturn');

namespace App\Controller;

class PostsController extends AppController
{
    public function my_action()
    {
        $this->render('custom_file');
    }
}

namespace App\Controller;

class PostsController extends AppController
{
    public function my_action()
    {
        $this->render('Users.UserDetails/custom_file');
    }
}

Перенаправление на другие страницы¶

Cake\Controller\Controller::redirect(string|array $url, integer $status)¶

Метод управления потоком, который вы будете использовать чаще всего это Controller::redirect(). Этот метод принимает свой первый параметр в виде CakePHP-относительного URL. Когда пользователь успешно разместил заказ, вы можете перенаправить его на экран квитанции.

public function place_order()
{
    // Логика для завершения заказа размещается здесь
    if ($success) {
        return $this->redirect(
            ['controller' => 'Orders', 'action' => 'thanks']
        );
    }
    return $this->redirect(
        ['controller' => 'Orders', 'action' => 'confirm']
    );
}

Метод вернет экземпляр ответа с соответствующим набором заголовков. Вы должны вернуть экземпляр ответа из своего экшена, чтобы предотвратить вывод вида и позволить диспетчеру обработать фактическое перенаправление.

Вы также можете использовать относительный или абсолютный URL в качестве значения аргумента $url:

return $this->redirect('/orders/thanks');
return $this->redirect('http://www.example.com');

Также вы можете передавать данные в экшен:

return $this->redirect(['action' => 'edit', $id]);

Второй параметр метода Controller::redirect() позволяет вам определять код HTTP-статуса сопровождающий перенаправление. Возможно вы захотите использовать код 301 (moved permanently) или 303 (see other), в зависимости от природы перенапрвления.

Если вы хотите осуществить перенаправление на страницу-источник запроса, вы можете сделать это следующим образом:

return $this->redirect($this->referer());

Пример использования строк запроса и хэш-ссылок:

return $this->redirect([
    'controller' => 'Orders',
    'action' => 'confirm',
    '?' => [
        'product' => 'pizza',
        'quantity' => 5
    ],
    '#' => 'top'
]);

Это создаст следующий URL:

http://www.example.com/orders/confirm?product=pizza&quantity=5#top

// Из экшена delete, вы можете вывести обновленную
// страницу списка.
$this->setAction('index');

Загрузка дополнительных моделей¶

Cake\Controller\Controller::loadModel(string $modelClass, string $type)¶

Функция loadModel() удобна, когда вам нужно использовать таблицу/коллекцию модели, которая не является стандартной для контроллера:

// В методе контроллера.
$this->loadModel('Articles');
$recentArticles = $this->Articles->find('all', [
    'limit' => 5,
    'order' => 'Articles.created DESC'
]);

Если вы используете поставщика таблиц, отличного от встроенной ORM, вы можете привязать эту систему таблиц к контроллерам CakePHP, подключив ее фабричный метод:

// В методе контроллера.
$this->modelFactory(
    'ElasticIndex',
    ['ElasticIndexes', 'factory']
);

После этого вы также сможете использовать loadModel для загрузки экземпляров:

// В методе контроллера.
$this->loadModel('Locations', 'ElasticIndex');

Пагинация модели¶

Cake\Controller\Controller::paginate()¶

Этот метод используется для разбивки на страницы результатов, полученных от ваших моделей. Вы можете указать размеры страниц, условия поиска моделей и многое другое. Смотрите pagination для более подробной информации о том, как использовать метод paginate().

Атрибут $paginate дает вам простой способ настройки поведения метода paginate():

class ArticlesController extends AppController
{
    public $paginate = [
        'Articles' => [
            'conditions' => ['published' => 1]
        ]
    ];
}

Настройка загружаемых компонентов¶

Cake\Controller\Controller::loadComponent($name, $config = [])¶

В методе initialize() вашего Контроллера вы можете определить любые компоненты, которые вы хотите загрузить, а также любые данные об их конфигурации:

public function initialize()
{
    parent::initialize();
    $this->loadComponent('Csrf');
    $this->loadComponent('Comments', Configure::read('Comments'));
}

property Cake\Controller\Controller::$components¶

Свойство $components в ваших контроллерах позволяет вам настроить компоненты. Конфигурируемые компоненты и их зависимости будут созданы CakePHP для вас. Прочтите раздел Настройка компонентов для более подробной информации. Как упоминалось ранее, свойство $components будет объединено со свойством, определенным в каждом из родительских классов вашего контроллера.

Настройка загружаемых хелперов¶

property Cake\Controller\Controller::$helpers¶

Давайте посмотрим, как сказать CakePHP, что мы хотим использовать дополнительные классы MVC:

class RecipesController extends AppController
{
    public $helpers = ['Form'];
}

Каждая из этих переменных объединяется с их унаследованными значениями, поэтому нет необходимости (к примеру) объявлять заново FormHelper или что-либо, что объявлено в вашем AppController.

Коллбеки жизненного цикла запроса¶

Контроллеры CakePHP запускают несколько событий/коллбеков, которые можно использовать для вставки логики вокруг жизненного цикла запроса:

//use Cake\Event\Event;
public function beforeFilter(Event $event)
{
    parent::beforeFilter($event);
}

Подробнее о контроллерах¶