Spec-Zone.ru › CakePHP 2.8

Класс ConnectionManager

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

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

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

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

  • $_connectionsEnum protected статический
    array
    Содержит список всех имён файлов и классов, используемых в настройках подключения
  • $_dataSources protected статический
    array
    Хранит экземпляры объектов DataSource
  • $_init protected статический
    boolean
    Указывает, был ли уже выполнен код инициализации для этого класса
  • $config public статический
    DATABASE_CONFIG
    Хранит загруженный экземпляр объекта Connections

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

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

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

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

_connectionData()source protected статический

_connectionData( array $config )

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

Параметры

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

Возвращает

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

_getConnectionObject()source protected статический

_getConnectionObject( string $name )

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

Параметры

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

Исключения

MissingDatasourceConfigException

_init()source protected статический

_init( )

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

create()source public статический

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

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

Параметры

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

Возвращает

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

drop()source public статический

drop( string $name )

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

Параметры

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

Возвращает

boolean
успех, если подключение было удалено, false, если его нет

enumConnectionObjects()source public статический

enumConnectionObjects( )

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

Возвращает

массив

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


getDataSource()source public статический

getDataSource( string $name )

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

Параметры

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

Возвращает

DataSource
Экземпляр

Исключения

MissingDatasourceException

getSourceName()source public статический

getSourceName( DataSource $source )

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

Параметры

DataSource $source
Объект DataSource

Возвращает

строка|null

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


loadDataSource()source public статический

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 статический

sourceList( )

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

Возвращает

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

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

$_connectionsEnumsource

protected статический массив

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

array()

$_dataSourcessource

protected статический массив

Хранит экземпляры объектов 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.
http://api.cakephp.org/2.8/class-ConnectionManager.html

Spec-Zone.ru

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