Класс HelperRegistry

__construct()source public

__construct( Cake\View\View $view )

Конструктор

Параметры

Cake\View\View $view

Объект View.

__get()source public

__get( string $name )

Предоставление публичного чтения загруженных объектов

Параметры

string $name

Имя свойства для чтения

Возвращает

mixed

Переопределяет

Cake\Core\ObjectRegistry::__get()

__isset()source public

__isset( string $helper )

Попытка ленивой загрузки помощника по его имени. Если помощник не найден в папке приложения, то поиск производится в текущем плагине.

Параметры

string $helper

Имя помощника для загрузки

Возвращает

boolean
является ли помощник загруженным

Исключения

Cake\View\Exception\MissingHelperException

Если помощник не найден. Поиск помощников сначала в папке приложения, затем в плагинах.

Переопределяет

Cake\Core\ObjectRegistry::__isset()

_create()source protected

_create( string $class , string $alias , array $settings )

Создание экземпляра помощника.

Часть шаблона метода Cake\Core\ObjectRegistry::load(). Загруженные помощники будут зарегистрированы в диспетчере событий.

Параметры

string $class

Класс для создания.

string $alias

Псевдоним загруженного помощника.

array $settings

Массив настроек для помощника.

Возвращает

Cake\Controller\Component
Созданный класс помощника.

_resolveClassName()source protected

_resolveClassName( string $class )

Разрешение имени класса помощника.

Часть шаблона метода Cake\Core\ObjectRegistry::load()

Параметры

string $class

Частичное имя класса для разрешения.

Возвращает

string|false
Правильное имя класса или false.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Выбрасывает исключение при отсутствии помощника.

Часть шаблона метода Cake\Core\ObjectRegistry::load()

Параметры

string $class

Отсутствующий класс.

string $plugin

Плагин, в котором отсутствует помощник.

Исключения

Cake\View\Exception\MissingHelperException

__debugInfo()source public

__debugInfo( )

Свойства объекта для удобства отладки.

Возвращает

array

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

Проверка на дублирование загружаемых объектов.

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

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

Параметры

string $name

Имя псевдонима в реестре.

array $config

Данные конфигурации для нового экземпляра.

Исключения

RuntimeException
При обнаружении дубликата.

get()source public

get( string $name )

Получение экземпляра загруженного объекта.

Параметры

string $name

Имя объекта.

Возвращает

object|null
Экземпляр объекта, если загружен, иначе null.

has()source public

has( string $name )

Проверка наличия загруженного объекта.

Параметры

string $name

Имя проверяемого объекта.

Возвращает

boolean
True, если объект загружен, иначе false.

load()source public

load( string $objectName , array $config [] )

Загрузка/создание экземпляра объекта.

Вернёт экземпляр из реестра, если он уже существует. Если подкласс предоставляет поддержку событий, можно использовать $config['enabled'] = false для исключения созданных объектов из регистрации событий.

Например, используя Cake\Controller\Controller::$components. Можно задать псевдоним объекта, установив ключ 'className', например:

public $components = [
  'Email' => [
    'className' => '\App\Controller\Component\AliasedEmailComponent'
  ];
];

Все вызовы компонента Email будут использовать AliasedEmail вместо этого.

Параметры

string $objectName

Имя/класс объекта для загрузки.

array $config optional []

Дополнительные настройки при загрузке объекта.

Возвращает

mixed

loaded()source public

loaded( )

Получение списка загруженных объектов.

Возвращает

array
Список имён объектов.

normalizeArray()source public

normalizeArray( array $objects )

Нормализация массива объектов, создание массива, который упрощает ленивую загрузку

Параметры

array $objects

Массив дочерних объектов для нормализации.

Возвращает

array
Массив нормализованных объектов.

reset()source public

reset( )

Очистка загруженных экземпляров в реестре.

Если подкласс реестра имеет диспетчер событий, объекты также будут отсоединены от событий.

set()source public

set( string $objectName , object $object )

Непосредственно установить объект в реестр по имени.

Если этот набор реализует события, переданный объект будет присоединен к диспетчеру событий.

Параметры

строка $objectName

Имя объекта для установки в реестр.

объект $object

экземпляр для хранения в реестре

unload()source public

unload( string $objectName )

Удалить объект из реестра.

Если у этого реестра есть диспетчер событий, объект также будет отключен от любых событий.

Параметры

строка $objectName

Имя объекта для удаления из реестра.

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обертка для создания и отправки событий.

Возвращает обработанное событие.

Параметры

строка $name

Имя события.

массив|null $data необязательно null

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

объект|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр диспетчера событий Cake\Event\EventManager для этого объекта.

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

Параметры

Cake\Event\EventManager $eventManager необязательно null

диспетчер событий для установки

Возвращает

Cake\Event\EventManager