Class HelperRegistry

Регистр для помощников. Предоставляет функции для ленивой загрузки помощников.

Пространство имён: Cake\Console

Краткое описание свойств

$_io protected

Cake\Console\ConsoleIo

Оболочка для установки параметров задач.
$_loaded protected

object[]

Карта загруженных объектов.

Краткое описание методов

__debugInfo() public

Свойства объекта для отладки.
__get() public

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

Предоставить доступ isset к _loaded.
__set() public

Устанавливает объект.
__unset() public

Удаляет объект.
_checkDuplicate() protected

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

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

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

Выбрасывает исключение, если помощник отсутствует.
count() public

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

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

Возвращает итератор массива.
has() public

Проверка наличия заданного объекта.
load() public

Загрузка/создание экземпляра объекта.
loaded() public

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

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

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

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

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

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

Подробное описание методов

__debugInfo() public

__debugInfo(): array

Свойства объекта для отладки.

Возвращает

array

__get() public

__get(string $name): object|null

Обеспечивает общедоступный чтение загруженных объектов.

Параметры

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

Возвращает

object|null

__isset() public

__isset(string $name): bool

Обеспечивает доступ isset к _loaded.

Параметры

string $name: Имя проверяемого объекта.

Возвращает

bool

__set() public

__set(string $name, object $object): void

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

Параметры

string $name: Имя свойства для установки.
object $object: Устанавливаемый объект.

Возвращает

void

__unset() public

__unset(string $name): void

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

Параметры

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

Возвращает

void

_checkDuplicate() protected

_checkDuplicate(string $name, array $config): void

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

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

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

Параметры

string $name: Имя псевдонима в реестре.
array $config: Данные конфигурации для нового экземпляра.

Возвращает

void

Исключение

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

_create() protected

_create(string|object $class, string $alias, array $config): Cake\Console\Helper

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

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

Параметры

string|object $class: Имя класса для создания.
string $alias: Псевдоним помощника.
array $config: Массив настроек для помощника.

Возвращает

Cake\Console\Helper

_resolveClassName() protected

_resolveClassName(string $class): string|null

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

Будет отдавать предпочтение помощникам, определенным в Command\Helper по сравнению с помощниками, определенными в Shell\Helper.

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

Параметры

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

Возвращает

string|null

_throwMissingClassError() protected

_throwMissingClassError(string $class, string|null $plugin): void

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

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

Параметры

string $class: Отсутствующее имя класса.
string|null $plugin: Плагин, в котором отсутствует помощник.

Возвращает

void

Исключение

Cake\Console\Exception\MissingHelperException

count() public

count(): int

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

Возвращает

int

get() public

get(string $name): object

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

Параметры

string $name: Имя объекта.

Возвращает

object

Исключение

RuntimeException
Если объект не загружен или не найден.

getIterator() public

getIterator(): Traversable

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

Возвращает

Traversable

has() public

has(string $name): bool

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

Параметры

string $name: Имя проверяемого объекта.

Возвращает

bool

load() public

load(string $name, array $config = []): mixed

Загрузка/создание экземпляра объекта.

Возвращает экземпляр из реестра, если он уже существует. Если подкласс поддерживает события, вы можете использовать $config['enabled'] = false чтобы исключить созданные объекты из регистрации для событий.

Пример Cake\Controller\Controller::$components. Вы можете назначить псевдоним объекту, установив ключ 'className', например:

protected $components = [
  'Email' => [
    'className' => 'App\Controller\Component\AliasedEmailComponent'
  ];
];

Все вызовы к компоненту Email будут использовать AliasedEmail вместо.

Параметры

string $name: Имя/класс объекта для загрузки.
array $config optional: Дополнительные настройки для загрузки объекта.

Возвращает

mixed

Исключение

Exception
Если класс не найден.

loaded() public

loaded(): string[]

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

Возвращает

string[]

normalizeArray() public

normalizeArray(array $objects): array[]

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

Параметры

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

Возвращает

array[]

reset() public

reset(): $this

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

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

Возвращает

$this

set() public

set(string $name, object $object): $this

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

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

Параметры

string $name: Имя объекта для установки в реестр.
object $object: экземпляр для хранения в реестре

Возвращает

$this

setIo() public

setIo(Cake\Console\ConsoleIo $io): void

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

Параметры

Cake\Console\ConsoleIo $io: Экземпляр io.

Возвращает

void

unload() public

unload(string $name): $this

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

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

Параметры

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

Возвращает

$this

Подробное описание свойств

`$_io` защищенное

Оболочка для установки параметров задач.

Тип

Cake\Console\ConsoleIo

`$_loaded` защищенное

Карта загруженных объектов.

Тип

object[]

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Console.HelperRegistry.html