Класс ConnectionManager
Управляет загруженными экземплярами объектов DataSource.
Предоставляет интерфейс для загрузки и перечисления соединений, определённых в app/Config/database.php.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Model/ConnectionManager.php
Краткое описание свойств
- Содержит список всех имён файлов и классов, используемых в настройках соединений.
array - Хранит экземпляры объектов DataSource.
array - Указывает, был ли уже выполнен код инициализации для этого класса.
boolean - Хранит загруженный экземпляр объекта Connections.
DATABASE_CONFIG
Краткое описание методов
- Возвращает имя файла, имя класса и родителя для данного драйвера.
- Получает список имён классов и файлов, связанных с пользовательскими соединениями DataSource.
- Загружает конфигурацию соединений.
- Динамически создаёт объект DataSource во время выполнения с заданным именем и настройками.
- Удаляет конфигурацию соединения во время выполнения по заданному имени.
- Возвращает список соединений.
- Получает ссылку на объект DataSource.
- Получает имя DataSource по ссылке на объект.
- Загружает класс DataSource для данного имени соединения.
-
Получает список доступных соединений DataSource. Это вернёт только те DataSource, которые были созданы этим менеджером. Отличается от enumConnectionObjects, так как последний вернёт все настроенные соединения.
Подробное описание методов
_connectionData()source protected static
_connectionData( array $config )
Возвращает имя файла, имя класса и родителя для данного драйвера.
Параметры
- массив
$config - Массив с конфигурацией соединения. Ключ 'datasource' обязателен.
Возвращает
массивИндексированный массив с: именем файла, именем класса, плагином и родителем
_getConnectionObject()source protected static
_getConnectionObject( string $name )
Получает список имён классов и файлов, связанных с пользовательскими соединениями DataSource.
Параметры
- строка
$name - Имя соединения
Исключения
MissingDatasourceConfigExceptioncreate()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 - имя соединения, как оно было создано
Возвращает
логическое значениеtrue, если соединение было удалено, false, если его нет
enumConnectionObjects()source public static
enumConnectionObjects( )
Возвращает список соединений.
Возвращает
массивАссоциативный массив элементов, где ключ — имя соединения (как определено в Connections), а значение — массив с ключами 'filename' и 'classname'.
getDataSource()source public static
getDataSource( string $name )
Получает ссылку на объект DataSource.
Параметры
- строка
$name - Имя DataSource, как определено в app/Config/database.php
Возвращает
DataSourceЭкземпляр
Исключения
MissingDatasourceExceptiongetSourceName()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/.
Возвращает
логическое значениеtrue при успехе, null при ошибке или false, если класс уже загружен
Исключения
MissingDatasourceExceptionsourceList()source public static
sourceList( )
Получает список доступных соединений DataSource. Это вернёт только те DataSource, которые были созданы этим менеджером. Отличается от enumConnectionObjects, так как последний вернёт все настроенные соединения.
Возвращает
массивСписок доступных соединений
Подробное описание свойств
$_connectionsEnumsource
protected static массив
Содержит список всех имён файлов и классов, используемых в настройках соединений.
array()
$_initsource
protected static boolean
Указывает, был ли уже выполнен код инициализации для этого класса.
false
$configsource
public static DATABASE_CONFIG
Содержит загруженный экземпляр объекта Connections.
null
© 2005–2017 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.10/class-ConnectionManager.html