Spec-Zone.ru › CakePHP 3.6

Класс ConnectionRegistry

Объект-регистр для экземпляров подключений.

Cake\Core\ObjectRegistry implements Countable, IteratorAggregate
Extended by Cake\Datasource\ConnectionRegistry
Пространство имён: Cake\Datasource
См.: Cake\Datasource\ConnectionManager
Расположение: Datasource/ConnectionRegistry.php

Унаследованные свойства

  • _loaded

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

  • _create() protected
    Создать объект подключения с правильными настройками.
  • _resolveClassName() protected
    Разрешить имя класса источника данных.
  • _throwMissingClassError() protected
    Выбрасывает исключение, когда отсутствует источник данных
  • unload() public
    Удалить один адаптер из реестра.

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

_create()source protected

_create( string|object|callable $class , string $alias , array $settings )

Создать объект подключения с правильными настройками.

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

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

Параметры

string|object|callable $class
Имя класса или объект для создания.
string $alias
Псевдоним объекта.
array $settings
Массив настроек для использования источника данных.

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

object
Подключение с правильными настройками.

_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\Datasource\Exception\MissingDatasourceException

unload()source public

unload( string $name )

Удалить один адаптер из реестра.

Параметры

string $name
Имя адаптера.

Переопределяет

Cake\Core\ObjectRegistry::unload()

Методы, унаследованные от Cake\Core\ObjectRegistry

__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

__set()source public

__set( string $name , mixed $object )

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

Параметры

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

__unset()source public

__unset( string $name )

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

Параметры

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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Исключения

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

count()source public

count( )

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

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

integer

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

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

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

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

getIterator()source public

getIterator( )

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

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

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

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

Параметры

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

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

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

Параметры

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

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

mixed

Исключения

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

loaded()source public

loaded( )

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

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

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

reset()source public

reset( )

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

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

Возвращает


$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName
Имя объекта, который нужно установить в реестре.
объект $object
экземпляр для хранения в реестре

Возвращает


$this

© 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/3.6/class-Cake.Datasource.ConnectionRegistry.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API