Класс 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 )

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

Будет отдавать предпочтение хелперам, определённым в Command\Helper перед теми, что определены в Shell\Helper.

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

Параметры

строка $class

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

Возвращает

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

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

строка $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

Название проверяемого объекта.

Возвращает

булево значение

__set()source public

__set( string $name , mixed $object )

Устанавливает объект.

Параметры

строка $name

Имя свойства для установки.

смешанный тип $object

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

__unset()source public

__unset( string $name )

Удаляет объект.

Параметры

строка $name

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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Выбрасывает

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

count()source public

count( )

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

Возвращает

целое число

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

getIterator()source public

getIterator( )

Возвращает итератор массива.

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение
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 вместо этого.

Параметры

строка $objectName

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

массив $config необязательно []

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

Возвращает

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

Выбрасывает

Исключение
Если класс не найден.

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

array $objects

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

Возвращаемое значение

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

reset()source public

reset( )

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

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

Возвращаемое значение

$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

string $objectName

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

object $object

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

Возвращаемое значение

$this

unload()source public

unload( string $objectName )

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

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

Параметры

string $objectName

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

Возвращаемое значение

$this