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

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

Возвращает

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

_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 optional []

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

Возвращает

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

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

массив $objects

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

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

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

reset()source public

reset( )

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

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

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

$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

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

$this

unload()source public

unload( string $objectName )

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

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

Параметры

строка $objectName

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

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

$this