Класс WidgetRegistry

__constructsource public

__construct( Cake\View\StringTemplate $templates , Cake\View\View $view , string|array $widgets [] )

Конструктор

Параметры

Cake\View\StringTemplate $templates

Экземпляр шаблонов для использования.

Cake\View\View $view

Экземпляр представления, устанавливаемый как виджет.

string|array $widgets необязательно []

См. метод add() для получения дополнительной информации.

_resolveWidgetsource protected

_resolveWidget( mixed $widget )

Разрешает спецификацию виджета в экземпляр.

Параметры

mixed $widget

Виджет для получения

Возвращает

Cake\View\Widget\WidgetInterface
Интерфейс Widget

Выбрасывает

RuntimeException
если класс не может быть загружен или не реализует интерфейс WidgetInterface.

addsource public

add( array $widgets )

Добавляет или заменяет существующие экземпляры/конфигурации виджетов новыми.

Массивы виджетов могут быть либо описаниями, либо экземплярами. Например:

$registry->add([
  'label' => new MyLabelWidget($templates),
  'checkbox' => ['Fancy.MyCheckbox', 'label']
]);

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

Параметры

array $widgets

Массив виджетов для использования.

Выбрасывает

RuntimeException
Если класс не реализует интерфейс WidgetInterface.

clearsource public

clear( )

Очистить регистр и сбросить виджеты.

getsource public

get( string $name )

Получить виджет.

Будет либо извлекать уже созданный виджет, либо создавать новый экземпляр, если виджет был определён. Если виджет не определён, возвращается экземпляр виджета _default. Исключение будет выброшено, если виджет _default не определён.

Параметры

string $name

Имя виджета для получения.

Возвращает

Cake\View\Widget\WidgetInterface
класс интерфейса виджета.

Выбрасывает

RuntimeException
если виджет не определён.

loadsource public

load( string $file )

Загрузить файл конфигурации, содержащий виджеты.

Файлы виджетов должны определять переменную $config, содержащую все виджеты для загрузки. Загруженные виджеты будут объединены с существующими виджетами.

Параметры

string $file

Файл для загрузки

[]