Представления¶

Варианты вывода значений переменных¶

C помщью стандартных чзыковых конструкций echo или print:

<?php echo $variable; ?>

С использованием сокращенного синтаксиса:

<?= $variable ?>

Альтернативные управляющие конструкции¶

Управляющие конструкции, такие как if, for, foreach, switch, и while могут быть записаны в упрощенном формате. Заметьте, что в этом случае не используются фигурные скобки. Вместо этого, к примеру для закрытия конструкции foreach закрывающая фигурная скобка заменяется на endforeach. Каждая из перечисленных выше управляющих конструкций, имеет схожий синтаксис закрытия: endif, endfor, endforeach, и endwhile.Также заметьте, что вместо использования точки с запятой после каждой структуры (за исключением последней) используется знак двоеточие.

Пример использования foreach:

<ul>
<?php foreach ($todo as $item): ?>
  <li><?= $item ?></li>
<?php endforeach; ?>
</ul>

Еще пример, использование if/elseif/else. Обратите внимание на двоеточия:

<?php if ($username === 'салли'): ?>
   <h3>Привет Салли</h3>
<?php elseif ($username === 'джо'): ?>
   <h3>Привет Джо</h3>
<?php else: ?>
   <h3>Привет неизвестный пользователь</h3>
<?php endif; ?>

Если же вы предпочтете использовать шаблонизаторы, подобные Twig, подкласс Представления будет посредничать между вашим шаблонизатором и CakePHP.

Файлы шаблонов хранятся в src/Template/ в папке с именем, соответствующим имени контроллера, использующего файлы, и имеют названия в честь экшенов, которые им соответствуют. Например, файл представления для экшена view() контроллера Products, обычно располагается по следующему пути - src/Template/Products/view.ctp.

Слой представления в CakePHP может быть разбит на несколько составляющих частей. Каждая часть имеет свое предназначение и будет рассмотрена далее в этой главе:

• шаблоны: Шаблоны - это часть страницы уникальная для текущего экшена. Они формируют основной костяк ответа на запрос в вашем приложении.

• элементы: небольшая часть кода представления, которую можно использовать повторно. Элементы как правило выводятся внутри представлений.

• макеты: файлы шаблонов, содержащие код визуализации, которые оборачивают собой множество интерфейсов в вашем приложении. Большинство представлений выводятся внутри макета.

• хелперы: эти классы инкапсулируют логику представления, которая необходима во многих местах слоя представления. Наряду с другими вещами, хелперы в CakePHP могут помочь вам создать формы, построить AJAX-функциональность, разбить на страницы данные модели или транслировать RSS-каналы.

• ячейки: эти классы предоставляют возможности схожие с функционалом контроллеров, но в меньшем масштабе, используемые при создании самодостаточных UI-компоненов. Для более подробной информации смотрите раздел Ячейки.

Переменные Представления¶

Любые переменные, заданные в вашем контроллере с помощью метода set(), будут доступны как в представлении, так и в макете вашего экшена. Кроме того, любые заданные переменные также будут доступны в любом элементе. Если вам нужно передать дополнительные переменные из представления в макет, вы можете либо вызвать set() в шаблоне представления, либо использовать блоки представления.

Помните, вы всегда должны экранировать любые пользовательские данные перед их выводом. Вы можете сделать это с помощью функции h():

<?= h($user->bio); ?>

Назначение переменных Представления¶

Cake\View\View::set(string $var, mixed $value)¶

Представления имеют метод set() аналогичный методу set() в объектах Контроллера. Использование метода set() из вашего файла представления добавит переменные в макет и элементы, которые будут отображаться позже. См. Назначение переменных вида для более подробной информации.

Вы можете сделать следующее в вашем файле представления:

$this->set('activeMenuButton', 'posts');

Тогда в вашем макете будет доступна переменная $activeMenuButton со значением „posts“.

Расширение Представлений¶

Расширение представлений дает вам возможность оборачивать одно представление в другое. Комбинирование этой возможности с блоками представления дает вам мощный способ для соблюдения принципа DRY. К примеру ваше приложение имеет сайдбар, который должен меняться в зависимости от конкретного отображаемого представления. Расширяя наиболее обобщенный файл представления, вы можете предотвратить повторение шаблонного кода для вашего сайдбара, и описывать только меняющиеся части:

<!-- src/Template/Common/view.ctp -->
<h1><?= $this->fetch('title') ?></h1>
<?= $this->fetch('content') ?>

<div class="actions">
    <h3>Related actions</h3>
    <ul>
    <?= $this->fetch('sidebar') ?>
    </ul>
</div>

Приведенный выше файл представления может быть использован в качестве родительского представления. Он ожидает, что представление, расширяющее его определит блоки sidebar и title. Блок content - это специальный блок, создаваемый CakePHP. Он будет содержать весь неохваченный контент из расширяющегося представления. Предположим, что в нашем файле представления имеется переменная $post, содержащая данные о нашем посте, в таком случае файл представления выглядел бы следующим образом:

<!-- src/Template/Posts/view.ctp -->
<?php
$this->extend('/Common/view');

$this->assign('title', $post->title);

$this->start('sidebar');
?>
<li>
<?php
echo $this->Html->link('edit', [
    'action' => 'edit',
    $post->id
]);
?>
</li>
<?php $this->end(); ?>

// Остальное содержимое будет доступно как блок 'content'
// в родительском представлении.
<?= h($post->body) ?>

Представление поста, приведенное выше, показывает, как вы можете расширить представление и заполнить набор блоков. Любое содержимое, которое не принадлежит определенному блоку, будет захвачено и помещено в специальный блок с именем content. Когда представление содержит обращение к методу extend(), выполнение продолжается до конца текущего файла представления. После завершения данного процесса, расширенный вид будет отображен. Вызов extend() более одного раза в файле представления будет переопределять родительское представление, которое будет обработано следующим:

$this->extend('/Common/view');
$this->extend('/Common/index');

В результате исполнения кода приведенного выше, для текущего представления родительским станет /Common/index.ctp.

У расширяемых представлений может быть столько уровней вложенности, сколько вы посчитаете нужным. При желании любое представление может расширять какое-нибудь другое представление. Каждое родительское представление будет получать содержимое предшествующего представления как содержимое блока content.

Вы можете получить перечень всех заполненных блоков с помощью метода blocks():

$list = $this->blocks();

Отображение блоков¶

Вы можете выводить блоки, используя метод fetch(). Данный метод выведет блок, возвращающий „“ если указанный блок не будет существовать:

<?= $this->fetch('sidebar') ?>

Вы также можете использовать fetch() для условного отображения контента, который должен окружать блок, если он существует. Это полезно в макетах или расширенных представлениях, где вы хотите по условию показать заголовки или другую разметку:

// В макете src/Template/Layout/default.ctp
<?php if ($this->fetch('menu')): ?>
<div class="menu">
    <h3>Опции меню</h3>
    <?= $this->fetch('menu') ?>
</div>
<?php endif; ?>

Вы также можете указать значение по умолчанию для блока, если оно не существует. Это позволяет добавлять содержимое-заполнитель, когда блок не существует. Вы можете указать значение по умолчанию, используя второй аргумент:

<div class="shopping-cart">
    <h3>Your Cart</h3>
    <?= $this->fetch('cart', 'Your cart is empty') ?>
</div>

Использование блоков для скриптов и CSS-файлов¶

HtmlHelper связывается с блоками представления, а каждый из его методов script(), css() и meta() обновляет блок с соответствующим именем при использовании с параметром block = true:

<?php
// В вашем файле представления
$this->Html->script('carousel', ['block' => true]);
$this->Html->css('carousel', ['block' => true]);
?>

// В вашем файле макета.
<!DOCTYPE html>
<html lang="en">
    <head>
    <title><?= $this->fetch('title') ?></title>
    <?= $this->fetch('script') ?>
    <?= $this->fetch('css') ?>
    </head>
    // Остальная часть макета

Cake\View\Helper\HtmlHelper также позволяет вам контролировать в каких именно блоках будут размещены скрипты и файлы CSS:

// В вашем файле представления
$this->Html->script('carousel', ['block' => 'scriptBottom']);

// В вашем файле макета.
<?= $this->fetch('scriptBottom') ?>

Использование макетов из плагинов¶

Если вы хотите использовать макет, который находится внутри плагина, вы можете использовать plugin syntax. Например, чтобы использовать макет контакта из плагина Contacts:

namespace App\Controller;

class UsersController extends AppController
{
    public function view_active()
    {
        $this->viewBuilder()->layout('Contacts.contact');
        // или для версий ниже 3.1
        $this->layout = 'Contacts.contact';
    }
}

Передача переменных в элемент¶

Вы можете передавать данные в элемент, используя второй аргумент метода element():

echo $this->element('helpbox', [
    "helptext" => "О, этот текст очень полезен."
]);

Внутри файла элемента все переданные переменные дступны как элементы массива параметров (аналогично работе метода Controller::set() в контроллере, работающемс файлами шаблонов). В примере выше файл src/Template/Element/helpbox.ctp может использовать переменную $helptext:

// Внутри файла src/Template/Element/helpbox.ctp
echo $helptext; // Выводит "О, этот текст очень полезен."

Метод View::element() также поддерживает опции для элемента. Это опции „cache“ и „callbacks“. Пример:

echo $this->element('helpbox', [
        "helptext" => "Это передано в элемент как $helptext",
        "foobar" => "Это передано в элемент как $foobar",
    ],
    [
        // использует настройку кэша "long_view"
        "cache" => "long_view",
        // установлен в true, чтобы вызывались методы before/afterRender для элемента
        "callbacks" => true
    ]
);

Кэширование элементов облегчается с помощью класса Cache. Вы можете настроить элементы для хранения в любой конфигурации кэша, которую вы настроили. Это дает вам большую гибкость, чтобы определить, где и как долго сохраняются элементы. Чтобы кэшировать разные версии одного и того же элемента в приложении, укажите уникальное значение ключа кеша, используя следующий формат:

$this->element('helpbox', [], [
        "cache" => ['config' => 'short', 'key' => 'уникальное значение']
    ]
);

Если вам требуется реализовать больше логики в вашем элементе, такие как динамически обновляемые данные, используйте для этого ячейки представления (View Cell) вместо элементов. Узнайте больше о Ячейках.

Кэширование элементов¶

Вы можете использовать преимущества кэширования представления CakePHP, если вы задаете параметр cache. Если установлено значение `` true``, он будет кэшировать элемент в конфигурации кэша „по умолчанию“. В противном случае вы можете назначить, какую конфигурацию кэша следует использовать. Смотрите Кэширование для получения дополнительной информации о настройке Cache. Простым примером кэширования элемента будет:

echo $this->element('helpbox', [], ['cache' => true]);

Если вы выводите один и тот же элемент более одного раза в представлении при включенном кешировании, обязательно устанавливайте параметр „key“ в другое значение каждый раз. Это предотвратит переопределение кэшированных результатов при каждом новом вызове метода element(). Например:

echo $this->element(
    'helpbox',
    ['var' => $var],
    ['cache' => ['key' => 'first_use', 'config' => 'view_long']]
);

echo $this->element(
    'helpbox',
    ['var' => $differenVar],
    ['cache' => ['key' => 'second_use', 'config' => 'view_long']]
);

Приведенный выше пример обеспечит независимое кэширование результатов для обоих элементов. Если вы хотите использовать общие параметры кэширования для всех элементов, вы можете избежать некоторых повторов в коде, указав желаемые параметры кэширования в View::$elementCache. CakePHP будет использовать эти параметры по умолчанию, если другие настройки не будут указаны явно.

Запрос элементов из плагина¶

Если вы используете плагин и хотите использовать элементы из плагина, просто используйте знакомый plugin syntax. Если представление создается для контроллера/экшена плагина, имя плагина будет автоматически ставиться перед всеми используемыми элементами до тех пор, пока не будет явно указано название другого плагина. Если нужный элемент отсутствует в плагине, он будет искаться в папке основного приложения:

echo $this->element('Contacts.helpbox');

Если ваше представление - это часть плагина, вы можете не указывать явно имя плагина. Например, если вы находитесь в контроллере ContactsController плагина Contacts, то следующие строки:

echo $this->element('helpbox');
// и
echo $this->element('Contacts.helpbox');

будут равнозначны по смыслу и выведут один и тот же элемент.

Для элементов внутри вложенных папок плагина (например, plugins/Contacts/Template/Element/sidebar/helpbox.ctp), используйте следующий синтаксис:

echo $this->element('Contacts.sidebar/helpbox');

Префикс маршрута и элементы¶

Если у вас в маршруте используется префикс, область видимости пути Элемента может переключиться на местоположение соответствующее префиксу, так же как это делают Макеты и Представления. Предположим у вас настроен префикс «Admin», и вы делаете следующий вызов:

echo $this->element('my_element');

Сначала элемент будет искаться в src/Template/Admin/Element/. Если его не окажется в той папке, то поиск продолжится по стандартному пути.

Кэширование секций вашего представления¶

Cake\View\View::cache(callable $block, array $options = [])¶

Иногда генерирование секции вывода вашего представления может быть дорогостоящим из-за обработки ячеек или ресурсоемких вспомогательных операций. Чтобы помочь вашему приложению работать быстрее, CakePHP предоставляет способ кэширования секций представления:

// Предполагаются некоторые локальные переменные
echo $this->cache(function () use ($user, $article) {
    echo $this->cell('UserProfile', [$user]);
    echo $this->cell('ArticleFull', [$article]);
}, ['key' => 'my_view_key']);

По умолчанию кэшированное содержимое представления будет передаваться в параметр конфигурации View::$elementCache, но вы можете использовать опцию config, чтобы изменить это.

Список событий¶

• View.beforeRender

• View.beforeRenderFile

• View.afterRenderFile

• View.afterRender

• View.beforeLayout

• View.afterLayout

Вы можете прикреплять обработчики приложения к указанным событиям, или использовать Коллбэки Хелпера.