Хелперы¶

Загрузка хелперов по условию¶

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

class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
        if ($this->request->getParam('action') === 'index') {
            $this->loadHelper('ListPage');
        }
    }
}

Вы можете также использовать метод beforeRender() вашего контроллера для загрузки хелперов:

class ArticlesController extends AppController
{
    public function beforeRender(Event $event)
    {
        parent::beforeRender($event);
        $this->viewBuilder()->helpers(['MyHelper']);
    }
}

Параметры конфигурации¶

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

namespace App\View\Helper;

use Cake\View\Helper;
use Cake\View\View;

class AwesomeHelper extends Helper
{

    // Хук initialize() доступен с версии 3.2. Для более ранних версий
    // вы можете переопределить конструктор, если это необходимо.
    public function initialize(array $config)
    {
        debug($config);
    }
}

Параметры могут быть определены при объявлении хелперов в контроллере, как показано ниже:

namespace App\Controller;

use App\Controller\AppController;

class AwesomeController extends AppController
{
    public $helpers = ['Awesome' => ['option1' => 'value1']];
}

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

namespace App\View\Helper;

use Cake\View\Helper;
use Cake\View\StringTemplateTrait;

class AwesomeHelper extends Helper
{

    use StringTemplateTrait;

    protected $_defaultConfig = [
        'errorClass' => 'error',
        'templates' => [
            'label' => '<label for="{{for}}">{{content}}</label>',
        ],
    ];
}

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

// Чтение параметра конфигурации errorClass.
$class = $this->Awesome->config('errorClass');

Использование конфигурации хелпера позволяет вам декларативно настраивать ваши хелперы и держать логику конфигурации за пределами экшенов вашего контроллера. Если у вас есть параметры конфигурации, которые не могут являться частью объявления класса, вы можете установить их в коллбеке beforeRender() вашего контроллера:

class PostsController extends AppController
{
    public function beforeRender(Event $event)
    {
        parent::beforeRender($event);
        $builder = $this->viewBuilder();
        $builder->helpers([
            'CustomStuff' => $this->_getCustomStuffConfig(),
        ]);
    }
}

Создание псевдонимов для хелперов¶

Одним из наиболее часто используемых параметров является className, который позволяет вам создавать хелперы, использующие псевдонимы внутри ваших представлений. Эта опция может оказаться полезной, когда вы захотите заменить стандартный вызов хелпера из представления, такой как например $this->Html на что-то более простое и понятное:

// src/View/AppView.php
class AppView extends View
{
    public function initialize()
    {
        $this->loadHelper('Html', [
            'className' => 'MyHtml'
        ]);
    }
}

// src/View/Helper/MyHtmlHelper.php
namespace App\View\Helper;

use Cake\View\Helper\HtmlHelper;

class MyHtmlHelper extends HtmlHelper
{
    // Добавьте сюда ваш код для переопределения функций HtmlHelper
}

Приведенный выше пример установит псевдоним MyHtmlHelper для вызова $this->Html в ваших представлениях.

Загрузка хелперов на лету¶

Иногда могут возникнуть ситуации, когда вам понадобится динамически загружать хелперы из представления. Вы можете использовать для этого класс представления Cake\View\HelperRegistry:

// Можете использовать любой из вариантов.
$mediaHelper = $this->loadHelper('Media', $mediaConfig);
$mediaHelper = $this->helpers()->load('Media', $mediaConfig);

HelperRegistry - это реестр и он поддерживает API реестра используемый повсеместно в CakePHP.

Встраивание других хелперов¶

Вы можете захотеть использовать функциональность, уже имеющуюся в каком-нибудь другом хелпере. Для этого вы можете определить нужные хелперы в массиве $helpers, отформатированный также, как и в контроллере:

/* src/View/Helper/LinkHelper.php (using other helpers) */

namespace App\View\Helper;

use Cake\View\Helper;

class LinkHelper extends Helper
{
    public $helpers = ['Html'];

    public function makeEdit($title, $url)
    {
        // Используйте HTML-хелпер для вывода
        // форматированных данных:

        $link = $this->Html->link($title, $url, ['class' => 'edit']);

        return '<div class="editOuter">' . $link . '</div>';
    }
}

Использование вашего хелпера¶

Как только вы создали ваш хелпер и разместили его в папке src/View/Helper/, вы можете загрузить его в ваших представлениях:

class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
        $this->loadHelper('Link');
    }
}

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

<!-- создание ссылки с помощью нового хелпера -->
<?= $this->Link->makeEdit('Change this Recipe', '/recipes/edit/5') ?>

Доступ к переменным представления внутри вашего хелпера¶

Если вы захотите получить доступ к переменной Представления внутри хелпера, вы можете использовать $this->_View->get():

class AwesomeHelper extends Helper
{

    public $helpers = ['Html'];

    public someMethod()
    {
        // установить мета-тег description
        echo $this->Html->meta(
            'description', $this->_View->get('metaDescription'), ['block' => 'meta']
        );
    }
}

Вывод элемента Представления внутри вашего хелпера¶

Если вы захотите вывести Элемент внутри вашего Хелпера, вы можете использовать $this->_View->element() следующим образом:

class AwesomeHelper extends Helper
{
    public someFunction()
    {
        // вывод непосредственно в вашем хелпере
        echo $this->_View->element(
            '/path/to/element',
            ['foo'=>'bar','bar'=>'foo']
        );

        // или возаращаем результат в
        // ваше представление
        return $this->_View->element(
            '/path/to/element',
            ['foo'=>'bar','bar'=>'foo']
        );
    }
}

Коллбэки¶

Реализуя метод обратного вызова в хелпере, CakePHP автоматически подпишет ваш хелпер на соответствующее событие. В отличие от предыдущих версий CakePHP вы не должны вызывать parent в своих обратных вызовах, поскольку базовый класс Helper не реализует ни один из методов обратного вызова.

Helper::beforeRenderFile(Event $event, $viewFile)¶

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

Helper::afterRenderFile(Event $event, $viewFile, $content)¶

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

Helper::beforeRender(Event $event, $viewFile)¶

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

Helper::afterRender(Event $event, $viewFile)¶

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

Helper::beforeLayout(Event $event, $layoutFile)¶

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

Helper::afterLayout(Event $event, $layoutFile)¶

Вызывается после завершения обработки макета. Получает в качестве аргумента имя файла макета.