Spec-Zone.ru › CakePHP 3.1

Класс ConnectionRegistry

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

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

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

_createsource protected

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

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

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

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

Параметры

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

Возвращает

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

_resolveClassNamesource protected

_resolveClassName( string $class )

Разрешить имя класса драйвера.

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

Параметры

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

Возвращает

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

_throwMissingClassErrorsource protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

string $class
Отсутствующий класс.
string $plugin
Плагин, в котором отсутствует драйвер.

Выбрасывает

Cake\Datasource\Exception\MissingDatasourceException
\Cake\Datasource\Exception\MissingDatasourceException

unloadsource public

unload( string $name )

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

Параметры

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

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

Cake\Core\ObjectRegistry::unload()

Наследованные методы из Cake\Core\ObjectRegistry

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

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

Возвращает

mixed
смешанное

__issetsource public

__isset( string $name )

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

Параметры

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

Возвращает

boolean
логическое значение

_checkDuplicatesource protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Выбрасывает

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

getsource public

get( string $name )

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

Параметры

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

Возвращает

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

hassource public

has( string $name )

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

Параметры

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

Параметры

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

Возвращает

mixed
смешанное

loadedsource public

loaded( )

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

Возвращает

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

normalizeArraysource public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

resetsource public

reset( )

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

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

setsource public

set( string $objectName , object $object )

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

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

Параметры

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

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

$_loadedsource

protected массив

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

[]

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Datasource.ConnectionRegistry.html

Spec-Zone.ru

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