Контроллеры

Пример “Страница витрины”

Рассмотрим работу контроллера на примере открытия(отображения) страницы в зоне клиента (витрине интернет-магазина).

Для примера будет использована детальная страница товара (карточка товара).

Параметр: dispatch=products.view

1. products — название контроллера.

   Будет подключен и выполнен код из контроллера: app/controllers/frontend/products.php

2. view — режим (mode). Это означает, что:

   1. В контроллере products.php будет выполнен код из секции $mode == 'view':

      if (mode == 'view') {
      
          // код php
      
      }
      

   2. Будет подключен шаблон отображения:

      /design/themes/basic/templates/views/products/view.tpl

      где /products/ — название контроллера, view — режим (mode).

По данному принципу отображаются все страницы платформы.

Пример “Страница в панели администратора”

Пример работы контроллера по отображению страницы в панели администратора.

Для примера будет использована страница редактирования товара, однако по данному принципу отображаются все страницы панели администратора.

Параметр: dispatch=products.update

Название контроллера: products

Будет подключен и выполнен контроллер: app/controllers/backend/products.php

Режим (mode): update

Это означает, что:

1. В контроллере app/controllers/backend/products.php будет выполнен код из секции:

   if (mode == 'update') {
   
       // код php
   
   }
   

2. Будет подключен шаблон:

   /design/backend/templates/views/products/update.tpl

Пример “Отправка формы”

Рассмотрим работу контроллера при нажатии кнопки и отправке данных формы (POST-запрос).

Для примера использована страница редактирования категории и нажатие кнопки “Сохранить”.

URL: demo.cs-cart.ru/panel.php?dispatch=categories.update&category_id=166

Когда мы нажимаем кнопку “Сохранить”, отправляется POST-запрос с данными формы редактирования категории на адрес demo.cs-cart.ru/panel.php. 1. Проверяем форму

Просмотрим исходный код формы:

Метод: POST

URL отправки формы: demo.cs-cart.ru/panel.php

Просмотрим исходный код кнопки “Сохранить”:

Параметр: dispatch[categories.update]

Итак, контроллер и режим (mode) известны.

2. Название контроллера: categories.

   Будет подключен и выполнен контроллер: app/controllers/backend/categories.php

3. Режим (mode): update

   В контроллере app/controllers/backend/categories.php будет выполнен код из секции POST и $mode == update:

   if ($_SERVER['REQUEST_METHOD'] == 'POST') {
   
       if ($mode == 'update') {
   
           // PHP код обработки формы, отправленной методом POST
   
       }
   
   }
   

4. Результатом работы контроллера по обработке POST-запроса будет перенаправление на страницу, заданную в контроллере. В данном примере контроллер сохранит изменения и выполнит перенаправление на ту же самую страницу demo.cs-cart.ru/panel.php?dispatch=categories.update&category_id=166. Процесс открытия данной страницы будет аналогичен примеру Страница в панели администратора .

Секция обработки POST-запросов

Применяется для обработки данных с форм, AJAX-запросов и т.д. Когда Вы нажимаете кнопку в панели администратора или витрине, то обработка запроса будет происходить именно в этой секции контроллера. Обычно работа контроллера в данной секции завершается переходом на другой (или этот же) контроллер, где вступает в работу секция обработки GET-запросов.

Секция всегда расположена перед секцией GET в файле контроллера и заключена в условие:

if ($_SERVER['REQUEST_METHOD'] == 'POST') {

    // ...

}

Секция POST разделена на блоки в зависимости от режима (mode) работы — mode_name:

if ($_SERVER['REQUEST_METHOD'] == 'POST') {

    if ($mode == 'update') {
        // [mode_name] — update
    }

    if ($mode == 'delete') {
        // [mode_name] — delete
    }

    return array(CONTROLLER_STATUS_OK, "[redirect_url]");
}

В конце секции POST обязательно необходимо вернуть массив с результатом работы, включающий статус и URL перенаправления:

return array(CONTROLLER_STATUS_OK, "[redirect_url]");

где:

CONTROLLER_STATUS_OK — константа со статусом работы контроллера.

[redirect_url] — URL для перенаправления после обработки запроса.

После обработки секции управление будет передано в функцию fn_dispatch(), и будет осуществлён последующий переход на [redirect_url].

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

<?php

if ($_SERVER['REQUEST_METHOD'] == 'POST') {

    if ($mode == 'update') {

        $data = array (
            'amount' => 5,
            'status' => 'A',
        );

        $product_id = 3;

        db_query('UPDATE ?:products SET ?u WHERE product_id = ?i', $data, $order_id);

    }

    return array(CONTROLLER_STATUS_OK, "products.update");
}

// Начало секции GET 
if ($mode == 'update') {
    //.......
}

Секция обработки GET-запросов

Применяется при открытии страниц или для получения информации из базы данных и вывода на экран. Когда Вы открываете страницу в браузере, именно данный раздел контроллера работает над данными для открытия страницы.

Секция GET-запросов всегда располагается после секции POST в файле контроллера и разделена на блоки режимов (mode) работы:

if ($mode == '[mode_name_1]') {

} elseif ($mode == '[mode_name_2]') {

}

Блоки $mode выполняются в зависимости от значения параметра URL параметра dispatch=[controller_name].[mode_name]

Работа контроллера в данной секции обычно заканчивается:

• Передачей обработанных данных в шаблон для отображения.
• Перенаправлением с помощью метода GET.
• Прекращением работы скрипта: exit;.

В первом случае Вам необходимо передать информацию на отображение с помощью функции:

$view->assign('template_var_name', $php_var_name);

// где $view = Registry::get('view');

В данном случае в шаблоне будет доступна smarty-переменная template_var_name, равная php_var_name.

После завершения работы контроллера работу автоматически продолжит функция fn_dispatch. Шаблон отображения будет определён автоматически, в нём будут доступны переменные, переданные контроллером.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<?php

// Подключение класса Registry
use Tygh\Registry; 

if ($_SERVER['REQUEST_METHOD'] == 'POST') {
    //......
}

// Секция GET
if ($mode == 'update') {

    $id = $_REQUEST['product_id'];

    $data = db_get_row("SELECT * FROM ?:products WHERE product_id = ?i", $id);

    Registry::get('view')->assign('data', $data);

} elseif ($mode == 'manage') {

    $products = fn_get_products($_REQUEST);

    Registry::get('view')->assign('products', $products);

}

Локальные функции

В конце контроллера могут быть расположены функции, которые доступны и выполнятся в рамках файла контроллера.

Также контроллеры используют:

• Функции из папки app/functions/

• Классы и методы классов из папки app/Tygh/

  Для использования классов в начале контроллера необходимо подключить класс, например:

  // Подключение класса Registry
  use Tygh\Registry;
  
  // Использование методов класса
  $view = Registry::get('view');