Класс 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 опционально []

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

Возвращает

смешанное

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