Класс HelperRegistry

__constructsource public

__construct( Cake\View\View $view )

Конструктор

Параметры

Cake\View\View $view

Объект представления.

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
смешанный тип

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

Cake\Core\ObjectRegistry::__get()

__issetsource public

__isset( string $helper )

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

Параметры

строка $helper

Имя хелпера для загрузки

Возвращает

boolean
загружен ли хелпер или нет

Выбрасывает

Cake\View\Exception\MissingHelperException
Когда хелпер не найден. Хелперы приложения ищут, а затем хелперы плагина.

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

Cake\Core\ObjectRegistry::__isset()

_createsource protected

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

Создаёт экземпляр хелпера.

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

Параметры

строка $class

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

строка $alias

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

массив $settings

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

Возвращает

Cake\Controller\Component
Созданный класс хелпера.

_resolveClassNamesource protected

_resolveClassName( string $class )

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

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

Параметры

строка $class

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

Возвращает

string|false
Либо правильное имя класса, либо false.

_throwMissingClassErrorsource protected

_throwMissingClassError( string $class , string $plugin )

Выбрасывает исключение, когда хелпер отсутствует.

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

Параметры

строка $class

Отсутствующее имя класса.

строка $plugin

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

Выбрасывает

Cake\View\Exception\MissingHelperException
\Cake\View\Exception\MissingHelperException

__debugInfosource public

__debugInfo( )

Отладочные свойства объекта.

Возвращает

array
массив

_checkDuplicatesource protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Выбрасывает

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

getsource public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

hassource public

has( string $name )

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

Параметры

строка $name

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

Возвращает

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

loadsource public

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

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

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

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

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

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

Параметры

строка $objectName

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

массив $config optional []

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

Возвращает

mixed
смешанный тип

loadedsource public

loaded( )

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

Возвращает

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

normalizeArraysource public

normalizeArray( array $objects )

Нормализует массив объектов, создаёт массив, который облегчает ленивую загрузку

Параметры

массив $objects

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

Возвращает

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

resetsource public

reset( )

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

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

setsource public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

unloadsource public

unload( string $objectName )

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

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

Параметры

строка $objectName

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

dispatchEventsource public

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

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

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

Параметры

строка $name

Имя события.

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

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

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

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

Возвращает

Cake\Event\Event
\Cake\Event\Event

Реализация

Cake\Event\EventDispatcherInterface::dispatchEvent()

eventManagersource public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Параметры

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

устанавливаемый менеджер событий

Возвращает

Cake\Event\EventManager
\Cake\Event\EventManager

Реализация

Cake\Event\EventDispatcherInterface::eventManager()

[]

'\Cake\Event\Event'

null