Spec-Zone.ru › CakePHP 2.9

Класс DataSource

Базовый класс DataSource

DataSource — это звено связи между моделями и источником данных, которые представляют модели.

CakeObject
Extended by DataSource

Прямые подклассы

  • DboSource

Косвенные подклассы

  • Mysql
  • Postgres
  • Sqlite
  • Sqlserver
Пакет: Cake\Model\Datasource
Ссылка: http://book.cakephp.org/2.0/ru/models/datasources.html#basic-api-for-datasources
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Model/Datasource/DataSource.php

Резюме свойств

  • $_baseConfig protected
    array
    Значение по умолчанию конфигурации конкретного DataSource
  • $_descriptions protected
    array
    Хранит ссылки на описания, загруженные DataSource
  • $_sources protected
    array
    Хранит список источников (таблиц) в DataSource
  • $_transactionStarted protected
    boolean
    Включена ли транзакция в данном DataSource
  • $cacheSources public
    boolean

    Следует ли кэшировать данные источника, такие как доступные таблицы и описания схем

  • $config public
    array
    Конфигурация DataSource
  • $connected public
    boolean
    Подключён ли DataSource?

Резюме методов

  • __construct() public
    Конструктор.
  • __destruct() public
    Закрывает текущий источник данных.
  • _cacheDescription() protected
    Кэширование описания DataSource
  • begin() public
    Начало транзакции
  • close() public
    Закрытие соединения. Переопределить в подклассах.
  • column() public
    Преобразование типов столбцов к базовым типам
  • commit() public
    Подтверждение транзакции
  • create() public
    Используется для создания новых записей. Операция "C" CRUD.
  • delete() public
    Удаление записи(ей) в источнике данных.
  • describe() public
    Возвращает описание модели (метаданные) или null, если не найдено.
  • enabled() public

    Проверяет, выполнены ли условия доступности DataSource. Часто используется из connect() для проверки поддержки перед установлением соединения.

  • getSchemaName() public
    Возвращает имя схемы. Переопределить в подклассах.
  • insertQueryData() public
    Заменяет {$__cakeID__$} и {$__cakeForeignKey__$} заполнители в данных запроса.
  • lastAffected() public
    Возвращает количество строк, затронутых последним запросом.
  • lastInsertId() public
    Возвращает ID, сгенерированный предыдущей операцией INSERT.
  • lastNumRows() public
    Возвращает количество строк, возвращенных последней операцией.
  • listSources() public
    Кэширует/возвращает кэшированные результаты для дочерних экземпляров
  • read() public
    Используется для чтения записей из DataSource. Операция "R" в CRUD
  • resolveKey() public
    Подлежит переопределению в подклассах.
  • rollback() public
    Откатить транзакцию
  • setConfig() public

    Устанавливает конфигурацию для DataSource. Объединяет информацию $config с _baseConfig и существующим свойством $config.

  • update() public
    Обновление записи(ей) в источнике данных.

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

__construct()source public 

__construct( array $config array() )

Конструктор.

Параметры

массив $config необязательно array()
Массив с информацией о конфигурации источника данных.

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

CakeObject::__construct()

__destruct()source public 

__destruct( )

Закрывает текущий источник данных.

_cacheDescription()source protected 

_cacheDescription( string $object , mixed $data null )

Кэширование описания DataSource

Параметры

строка $object
Имя объекта (модели) для кэширования
смешанное $data необязательно null
Описание модели, обычно строка или массив

Возвращает

смешанное

begin()source public 

begin( )

Начало транзакции

Возвращает

булево
Возвращает true, если транзакция не активна

close()source public 

close( )

Закрытие соединения. Переопределить в подклассах.

Возвращает

булево

column()source public 

column( string $real )

Преобразование типов столбцов к базовым типам

Параметры

строка $real
Действительный тип столбца (например, "varchar(255)")

Возвращает

строка
Абстрактный тип столбца (например, "string")

commit()source public 

commit( )

Подтверждение транзакции

Возвращает

булево
Возвращает true, если транзакция активна

create()source public 

create( Model $Model , array $fields null , array $values null )

Используется для создания новых записей. Операция "C" CRUD.

Подлежит переопределению в подклассах.

Параметры

Model $Model
Модель, которую необходимо создать.
массив $fields необязательно null
Массив полей для сохранения.
массив $values необязательно null
Массив значений для сохранения.

Возвращает

булево
успех
END_OF_DOCUMENT_MARKER

delete()source public 

delete( Model $Model , mixed $conditions null )

Удалить запись(и) в источнике данных.

Подлежит переопределению в подклассах.

Параметры

Model $Model
Класс модели, содержащий удаляемую запись(и)
mixed $conditions необязательно null
Условие для удаления.

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

boolean
Успех

describe()source public 

describe( Model|string $model )

Возвращает описание модели (метаданные) или null, если нет данных.

Параметры

Model|string $model
Модель для описания.

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

array|null
Массив метаданных для $model

enabled()source public 

enabled( )

Проверка выполнения условий для доступности источника данных. Часто используется из connect() для проверки поддержки перед установлением соединения.

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

boolean
Выполняются ли условия использования источника данных.

getSchemaName()source public 

getSchemaName( )

Возвращает имя схемы. Переопределите в подклассах.

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

string|null
Имя схемы

insertQueryData()source public 

insertQueryData( string $query , array $data , string $association , Model $Model , array $stack )

Заменяет заглушки {$__cakeID__$} и {$__cakeForeignKey__$} в данных запроса.

Параметры

string $query
Строка запроса, требующая замены.
array $data
Массив данных со значениями, которые будут вставлены в заглушки.
string $association
Имя модели ассоциации, которая заменяется.
Model $Model
Экземпляр модели.
array $stack
Стек контекста.

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

mixed
Строка данных запроса с заменёнными заглушками, или false при ошибке.

lastAffected()source public 

lastAffected( mixed $source null )

Возвращает количество строк, затронутых последним запросом.

Параметры

mixed $source необязательно null
Имя источника.

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

integer
Количество строк, затронутых последним запросом.

lastInsertId()source public 

lastInsertId( mixed $source null )

Возвращает ID, сгенерированный из предыдущей операции INSERT.

Параметры

mixed $source необязательно null
Имя источника.

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

mixed
Последний сгенерированный ключ ID в предыдущем INSERT

lastNumRows()source public 

lastNumRows( mixed $source null )

Возвращает количество строк, возвращенных последней операцией.

Параметры

mixed $source необязательно null
Имя источника.

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

integer
Количество строк, возвращенных последней операцией

listSources()source public 

listSources( mixed $data null )

Кэширует/возвращает кэшированные результаты для дочерних экземпляров

Параметры

mixed $data необязательно null
В данном классе не используется.

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

array|null
Массив доступных источников в этом источнике данных.

read()source public 

read( Model $Model , array $queryData array() , integer $recursive null )

Используется для чтения записей из источника данных. "R" в CRUD

Подлежит переопределению в подклассах.

Параметры

Model $Model
Модель, которая читается.
array $queryData необязательно array()
Массив данных запроса, используемый для поиска необходимых данных
integer $recursive необязательно null
Уровень ассоциации

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

mixed

resolveKey()source public 

resolveKey( Model $Model , string $key )

Подлежит переопределению в подклассах.

Параметры

Model $Model
Экземпляр модели
string $key
Имя ключа

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

string
Имя ключа модели.

rollback()source public 

rollback( )

Откатить транзакцию

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

boolean
Возвращает true, если транзакция в процессе

setConfig()source public 

setConfig( array $config array() )

Устанавливает конфигурацию для DataSource. Объединяет информацию $config с _baseConfig и существующим свойством $config.

Параметры

array $config необязательно array()
Массив конфигурации

update()source public 

update( Model $Model , array $fields null , array $values null , mixed $conditions null )

Обновить запись(и) в источнике данных.

Подлежит переопределению в подклассах.

Параметры

Model $Model
Экземпляр класса модели, который обновляется
array $fields необязательно null
Массив полей для обновления
array $values необязательно null
Массив значений для обновления $fields
mixed $conditions необязательно null
Массив условий для использования.

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

boolean
Успех

Методы, унаследованные от CakeObject

_mergeVars()source protected 

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет $property объекта с свойством в определении $class. Значение свойства данного класса будет объединено поверх $class'

Это обеспечивает некоторую магию DRY, предоставляемую CakePHP. Если вы хотите отключить его, переопределите этот метод как пустую функцию.

Параметры

array $properties
Имя свойств для объединения.
string $class
Класс для объединения свойства с.
boolean $normalize необязательно true
Установите в значение true, чтобы запустить свойства через Hash::normalize() перед объединением.

_set()source protected 

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

array $properties необязательно array()
Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected 

_stop( integer|string $status 0 )

Остановить выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

integer|string $status необязательно 0
см. http://php.net/exit для значений
END_OF_DOCUMENT_MARKER

dispatchMethod()source public 

dispatchMethod( string $method , array $params array() )

Вызывает метод данного объекта с заданными параметрами. Предоставляет объектно-ориентированную оболочку для call_user_func_array

Параметры

string $method
Имя вызываемого метода
array $params необязательно array()
Список параметров для вызова $method

Возвращает

mixed
Результат вызова метода

log()source public 

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения дополнительной информации о записи в журналы, см. CakeLog::write().

Параметры

string $msg
Сообщение журнала
integer $type необязательно LOG_ERR
Постоянная типа ошибки. Определена в app/Config/core.php.
null|string|array $scope необязательно null

Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о областях ведения журналов, см. CakeLog::config().

Возвращает

boolean
Успешность записи в журнал

requestAction()source public 

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров друг к другу или связывания плагинов с основным приложением. requestAction может использоваться для возвращения отрисованных представлений или извлечения возвращаемого значения от действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строку URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

string|array $url

Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

array $extra необязательно array()

Если массив включает ключ "return", он устанавливает AutoRender в true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

mixed

Булевое значение true или false при успехе/неудачи или содержимое отрисованного действия, если 'return' установлен в $extra.


toString()source public 

toString( )

Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

string
Имя этого класса

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

$_baseConfigsource

protected array

Настройка по умолчанию для конкретного DataSource

array()

$_descriptionssource

protected array

Содержит ссылки на описания, загруженные DataSource

array()

$_sourcessource

protected array

Содержит список источников (таблиц), содержащихся в DataSource

null

$_transactionStartedsource

protected boolean

Находится ли этот DataSource в середине транзакции

false

$cacheSourcessource

public boolean

Должны ли данные источника, такие как доступные таблицы и описания схем, кэшироваться

true

$configsource

public array

Настройка DataSource

array()

$connectedsource

public boolean

Подключены ли мы к DataSource?

false

© 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-DataSource.html

Spec-Zone.ru

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