Класс ConnectionManager

Управляет загруженными экземплярами объектов DataSource.

Предоставляет интерфейс для загрузки и перечисления подключений, определённых в app/Config/database.php.

Пакет: Cake\Модель
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/ConnectionManager.php

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

$_connectionsEnum protected static

array
Содержит список всех имён файлов и классов, используемых в настройках подключения.
$_dataSources protected static

array
Содержит экземпляры объектов DataSource.
$_init protected static

boolean
Указывает, был ли уже выполнен код инициализации для данного класса.
$config public static

DATABASE_CONFIG
Содержит загруженный экземпляр объекта Connections.

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

_connectionData() protected static
Возвращает файл, имя класса и родительский элемент для данного драйвера.
_getConnectionObject() protected static
Получает список имён классов и файлов, связанных с подключёнными источниками данных, определёнными пользователем.
_init() protected static
Загружает конфигурацию подключений.
create() public static
Динамически создаёт объект DataSource во время выполнения с заданным именем и настройками.
drop() public static
Удаляет конфигурацию подключения во время выполнения, задав его имя.
enumConnectionObjects() public static
Возвращает список подключений.
getDataSource() public static
Получает ссылку на объект DataSource.
getSourceName() public static
Получает имя DataSource из ссылки на объект.
loadDataSource() public static
Загружает класс DataSource для заданного имени подключения.
sourceList() public static

Получает список доступных подключений DataSource. Это вернёт только источники данных, созданные этим менеджером. Отличается от enumConnectionObjects, так как последний вернёт все сконфигурированные подключения.

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

_connectionData()source protected static

_connectionData( array $config )

Возвращает файл, имя класса и родительский элемент для данного драйвера.

Параметры

массив $config: Массив с конфигурацией подключения. Ключ 'datasource' обязателен.

Возвращает

массив
Индексированный массив с: именем файла, именем класса, плагином и родителем

_getConnectionObject()source protected static

_getConnectionObject( string $name )

Получает список имён классов и файлов, связанных с подключёнными источниками данных, определёнными пользователем.

Параметры

строка $name: Имя подключения

Исключения

MissingDatasourceConfigException

_init()source protected static

_init( )

Загружает конфигурацию подключений.

create()source public static

create( string $name '' , array $config array() )

Динамически создаёт объект DataSource во время выполнения с заданным именем и настройками.

Параметры

строка $name необязательно '': Имя DataSource
массив $config необязательно array(): Настройки конфигурации DataSource

Возвращает

DataSource|null
Ссылка на объект DataSource или null, если создание не удалось

drop()source public static

drop( string $name )

Удаляет конфигурацию подключения во время выполнения, задав его имя.

Параметры

строка $name: имя подключения, как оно было создано

Возвращает

boolean
успех, если подключение удалено, false, если оно не существует

enumConnectionObjects()source public static

enumConnectionObjects( )

Возвращает список подключений.

Возвращает

массив

Ассоциативный массив элементов, где ключ — имя подключения (определённое в Connections), а значение — массив с ключами 'filename' и 'classname'.

getDataSource()source public static

getDataSource( string $name )

Получает ссылку на объект DataSource.

Параметры

строка $name: Имя DataSource, как определено в app/Config/database.php

Возвращает

DataSource
Экземпляр

Исключения

MissingDatasourceException

getSourceName()source public static

getSourceName( DataSource $source )

Получает имя DataSource из ссылки на объект.

Параметры

DataSource $source: Объект DataSource

Возвращает

строка|null

Имя Datasource, или null, если источник отсутствует в ConnectionManager.

loadDataSource()source public static

loadDataSource( string|array $connName )

Загружает класс DataSource для заданного имени подключения.

Параметры

строка|массив $connName: Имя подключения (строка), как определено в app/Config/database.php, или массив, содержащий имя файла (без расширения) и имя класса объекта, которые нужно найти в app/Model/Datasource/ или lib/Cake/Model/Datasource/.

Возвращает

boolean
True при успехе, null при неудаче или false, если класс уже загружен

Исключения

MissingDatasourceException

sourceList()source public static

sourceList( )

Получает список доступных подключений DataSource. Это вернёт только источники данных, созданные этим менеджером. Отличается от enumConnectionObjects, так как последний вернёт все сконфигурированные подключения.

Возвращает

массив
Список доступных подключений

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

$_connectionsEnumsource

protected static массив

Содержит список всех имён файлов и классов, используемых в настройках подключения.

array()

$_dataSourcessource

protected static массив

Содержит экземпляры объектов DataSource.

array()

END_OF_DOCUMENT_MARKER

$_initsource

protected static boolean

Указывает, была ли уже выполнена инициализация кода для этого класса

false

$configsource

public static DATABASE_CONFIG

Содержит загруженный экземпляр объекта Connections

null

© 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.
https://api.cakephp.org/2.9/class-ConnectionManager.html