Класс HelperRegistry

_create()source protected

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

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

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

Параметры

string $class

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

string $alias

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

array $settings

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

Возвращает

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

_resolveClassName()source protected

_resolveClassName( string $class )

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

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

Параметры

string $class

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

Возвращает

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

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

string $class

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

string $plugin

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

Выбрасывает

Cake\Console\Exception\MissingHelperException

setIo()source public

setIo( Cake\Console\ConsoleIo $io )

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

Параметры

Cake\Console\ConsoleIo $io

Экземпляр ввода/вывода.

__debugInfo()source public

__debugInfo( )

Отладка дружественных свойств объекта.

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

mixed

__isset()source public

__isset( string $name )

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

Параметры

string $name

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

Возвращает

boolean

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

string $name

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

array $config

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

Выбрасывает

RuntimeException
Когда найден дубликат.

get()source public

get( string $name )

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

Параметры

string $name

Имя объекта.

Возвращает

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

has()source public

has( string $name )

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

Параметры

string $name

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

Возвращает

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

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

Параметры

string $objectName

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

array $config optional []

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

Возвращает

mixed

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

array $objects

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

Возвращает

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

reset()source public

reset( )

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

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

set()source public

set( string $objectName , object $object )

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

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

Параметры

string $objectName

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

object $object

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

unload()source public

unload( string $objectName )

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

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

Параметры

string $objectName

Имя объекта, который нужно удалить из реестра.