Класс HelperRegistry

_create()source protected

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

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

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

Параметры

строка $class

Имя класса для создания.

строка $alias

Псевдоним помощника.

массив $settings

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

Возвращает

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

_resolveClassName()source protected

_resolveClassName( string $class )

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

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

Параметры

строка $class

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

Возвращает

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

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

строка $class

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

строка $plugin

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

Выбрасывает

Cake\Console\Exception\MissingHelperException

setIo()source public

setIo( Cake\Console\ConsoleIo $io )

Устанавливает экземпляр IO, который должен быть передан помощникам оболочки

Параметры

Cake\Console\ConsoleIo $io

Экземпляр io.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанное

__isset()source public

__isset( string $name )

Предоставление доступа isset к _loaded

Параметры

строка $name

Имя объекта, который проверяется.

Возвращает

булево

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Выбрасывает

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

get()source public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

has()source public

has( string $name )

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

Параметры

строка $name

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

Возвращает

булево
Истина, если объект загружен, в противном случае ложь.

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 вместо него.

Параметры

строка $objectName

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

массив $config опционально []

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

Возвращает

смешанное

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

массив $objects

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

Возвращает

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

reset()source public

reset( )

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

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

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

unload()source public

unload( string $objectName )

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

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

Параметры

строка $objectName

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