Класс HelperRegistry

_createsource protected

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

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

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

Параметры

строка $class

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

строка $alias

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

массив $settings

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

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

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

_resolveClassNamesource protected

_resolveClassName( string $class )

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

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

Параметры

строка $class

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

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

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

_throwMissingClassErrorsource protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

строка $class

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

строка $plugin

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

Исключения

Cake\Console\Exception\MissingHelperException
\Cake\Console\Exception\MissingHelperException

setIosource public

setIo( Cake\Console\ConsoleIo $io )

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

Параметры

Cake\Console\ConsoleIo $io

Экземпляр io.

__debugInfosource public

__debugInfo( )

Отладочные свойства объекта.

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

array
массив

__getsource public

__get( string $name )

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

Параметры

строка $name

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

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

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

__issetsource public

__isset( string $name )

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

Параметры

строка $name

Имя проверяемого объекта.

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

boolean
булево

_checkDuplicatesource protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Исключения

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

getsource public

get( string $name )

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

Параметры

строка $name

Имя объекта.

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

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

hassource public

has( string $name )

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

Параметры

строка $name

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

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

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

loadsource 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 необязательно []

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

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

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

loadedsource public

loaded( )

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

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

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

normalizeArraysource public

normalizeArray( array $objects )

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

Параметры

массив $objects

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

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

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

resetsource public

reset( )

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

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

setsource public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

unloadsource public

unload( string $objectName )

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

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

Параметры

строка $objectName

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

[]