Класс DboSource

__construct()source public

__construct( array $config null , boolean $autoConnect true )

Конструктор

Параметры

массив $config необязательный null

Массив конфигурационной информации для источника данных.

логическое значение $autoConnect необязательный true

Подключаться ли источнику данных автоматически.

Исключения

MissingConnectionException
при невозможности подключения.

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

DataSource::__construct()

__destruct()source public

__destruct( )

Используется для хранения в кэше результатов метода in-memory methodCache

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

DataSource::__destruct()

_beginNested()source protected

_beginNested( )

Начать вложенную транзакцию

Возвращает

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

_buildFieldParameters()source protected

_buildFieldParameters( string $columnString , array $columnData , string $position )

Создать параметры поля в позиции

Параметры

строка $columnString

Неполная строка столбца

массив $columnData

Массив данных столбца.

строка $position

Тип позиции для использования. 'beforeDefault' или 'afterDefault' - распространены

Возвращает

строка
с добавленными параметрами поля.

_commitNested()source protected

_commitNested( )

Завершить вложенную транзакцию

Возвращает

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

_constructVirtualFields()source protected

_constructVirtualFields( Model $Model , string $alias , array $fields )

Преобразует виртуальные поля модели в SQL-выражения, которые будут извлекаться позже

Параметры

Model $Model

Модель, для которой нужно получить виртуальные поля.

строка $alias

Имя таблицы-псевдонима

массив $fields

Виртуальные поля, которые будут использоваться в запросе

Возвращает

массив

_dropTable()source protected

_dropTable( type $table )

Генерирует оператор "удаления таблицы" для одной таблицы

Параметры

type $table

Имя таблицы, которую нужно удалить

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

string
SQL-запрос на удаление таблицы

_execute()source protected

_execute( string $sql , array $params array() , array $prepareOptions array() )

Выполняет заданный SQL-запрос.

Параметры

string $sql

SQL-запрос

array $params optional array()

Список параметров, которые нужно привязать к запросу

array $prepareOptions optional array()

Параметры, которые нужно использовать в операторе подготовки

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

mixed

PDOStatement, если запрос выполняется без проблем, true — в случае успешного выполнения, false — при ошибке запроса, возвращающего нулевые строки (например, оператор CREATE), false в противном случае

Исключения

PDOException

_fetchHasAndBelongsToMany()source protected

_fetchHasAndBelongsToMany( Model $Model , string $query , array $ids , string $association )

Получение ассоциаций 'hasAndBelongsToMany'.

Параметры

Model $Model

Объект модели-владельца.

string $query

Запрос ассоциации.

array $ids

Массив идентификаторов связанных записей.

string $association

Имя ассоциации.

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

array
Результаты ассоциации.

_fetchHasMany()source protected

_fetchHasMany( Model $Model , string $query , array $ids )

Получение ассоциаций 'hasMany'.

Параметры

Model $Model

Объект модели-владельца.

string $query

Шаблон запроса ассоциации.

array $ids

Массив идентификаторов связанных записей.

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

array
Результаты ассоциации.

_filterResults()source protected

_filterResults( array $resultSet , Model $Model , array $filtered array() )

Пропускает результаты ассоциации через фильтры afterFind соответствующей модели.

Основная модель всегда исключается, потому что фильтрация выполняется позже методом Model::_filterResults().

Параметры

array $resultSet

$resultSet Ссылка на результат набора, который нужно отфильтровать.

Model $Model

Экземпляр модели, с которой нужно работать.

array $filtered optional array()

Список классов, которые уже отфильтрованы, чтобы их пропускать.

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

array
Массив результатов, отфильтрованных через $Model->afterFind.

_filterResultsInclusive()source protected

_filterResultsInclusive( array $resultSet , Model $Model , array $toBeFiltered array() )

Пропускает результаты ассоциации через фильтры afterFind соответствующей модели.

Аналогично DboSource::_filterResults(), но фильтрует только указанные модели. Основная модель не может быть указана, потому что этот вызов выполняет DboSource::_filterResults() внутри.

Параметры

array $resultSet

$resultSet Ссылка на результат набора, который нужно отфильтровать.

Model $Model

Экземпляр модели, с которой нужно работать.

array $toBeFiltered optional array()

Список классов, которые нужно отфильтровать.

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

array
Массив результатов, отфильтрованных через $Model->afterFind.

_getJoins()source protected

_getJoins( Model $Model )

Возвращает массив SQL-условий JOIN из ассоциаций модели.

Параметры

Model $Model

Модель, для которой нужно получить условия JOIN.

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

array

_matchRecords()source protected

_matchRecords( Model $Model , mixed $conditions null )

Получает список идентификаторов записей для заданных условий. Используется для многострочных обновлений и удалений в базах данных, которые не поддерживают псевдонимы в запросах UPDATE/DELETE.

Параметры

Model $Model

Модель, для которой нужно найти соответствующие записи.

mixed $conditions optional null

Условие сопоставления.

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

array
Список идентификаторов записей

_mergeAssociation()source protected

_mergeAssociation( array $data , array $merge , string $association , string $type , boolean $selfJoin false )

Объединяет ассоциацию с данными

Параметры

array $data

$data Данные для объединения.

array $merge

$merge Данные для объединения.

string $association

Имя ассоциации для объединения.

string $type

Тип ассоциации

boolean $selfJoin optional false

Является ли это самосвязью

_mergeConditions()source protected

_mergeConditions( mixed $query , mixed $assoc )

Объединяет набор условий (строка/массив).

Параметры

mixed $query

Запрос для объединения условий.

mixed $assoc

Имена ассоциаций.

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

array

_mergeHasMany()source protected

_mergeHasMany( array $resultSet , array $assocResultSet , string $association , Model $Model )

Объединяет результаты ассоциаций 'hasMany'.

Примечание: эта функция также обрабатывает форматирование данных.

Параметры

array $resultSet

$resultSet Данные для объединения.

array $assocResultSet

Данные для объединения.

string $association

Имя модели, которую объединяют.

Model $Model

Модель, к которой объединяют.

_parseKey()source protected

_parseKey( string $key , mixed $value , Model $Model null )

Извлекает идентификатор Model.field и оператор SQL-условия из строки, форматирует и вставляет значения, а затем объединяет их в SQL-фрагмент.

Параметры

string $key

Фрагмент SQL-ключа, содержащий поле и необязательный SQL-оператор

mixed $value

Значение(я), которое нужно вставить в строку

Model $Model optional null

Объект модели, инициирующий запрос

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

string

_prepareUpdateFields()source protected

_prepareUpdateFields( Model $Model , array $fields , boolean $quoteValues true , boolean $alias false )

Приводит поля и значения к кавычкам и подготавливает их для оператора UPDATE SQL

Параметры

Model $Model

Модель, для которой нужно подготовить поля.

array $fields

Поля для обновления.

boolean $quoteValues optional true

Если значения должны быть приведены к кавычкам или обработаны как SQL-фрагменты

boolean $alias optional false

Включить псевдоним модели в имя поля

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

array
Поля и значения, приведенные к кавычкам и подготовленные

_quoteFields()source protected

_quoteFields( string $conditions )

Приводит поля Model.fields к кавычкам.

Параметры

string $conditions

Условие, которое нужно привести к кавычкам.

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

string
или false, если соответствия нет

_quoteMatchedField()source protected

_quoteMatchedField( string $match )

Вспомогательная функция для приведения совпадений Model.fields из preg_replace_callback вызова к кавычкам.

Параметры

string $match

Совпавшая строка

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

string
строка в кавычках

_rollbackNested()source protected

_rollbackNested( )

Откатить вложенную транзакцию

Возвращает

boolean

_scrubQueryData()source protected

_scrubQueryData( array $data )

Вспомогательный метод для удаления метаданных запроса из заданного массива данных.

Параметры

массив $data

Данные для очистки.

Возвращает

массив

_writeQueryCache()source protected

_writeQueryCache( string $sql , mixed $data , array $params array() )

Записывает новый ключ для кэша запросов SQL в памяти

Параметры

строка $sql

Запрос SQL

смешанное $data

результат запроса $sql

массив $params необязательно массив()

параметры запроса, привязанные как значения

alterSchema()source public

alterSchema( mixed $compare , string $table null )

Генерирует синтаксис изменения из CakeSchema::compare()

Параметры

смешанное $compare

Данные сравнения.

строка $table необязательно null

Имя таблицы.

Возвращает

boolean

begin()source public

begin( )

Начать транзакцию

Возвращает

boolean

Истина при успехе, ложь при неудаче (т.е. если база данных/модель не поддерживает транзакции или транзакция не начата).

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

DataSource::begin()

boolean()source public

boolean( mixed $data , boolean $quote false )

Перевод между значениями булевых типов PHP и значениями булевых типов базы данных (моделирование)

Параметры

смешанное $data

Значение, подлежащее переводу

логическое $quote необязательно false

Признак преобразования поля в строку.

Возвращает

string|boolean
Преобразованное булевое значение

buildAssociationQuery()source public

buildAssociationQuery( Model $Model , array $queryData )

Создаёт SQL запрос.

Это всего лишь удобная обертка для DboSource::buildStatement().

Параметры

Model $Model

Модель для создания запроса ассоциации.

массив $queryData

Массив с информацией о данных запроса, содержащий ключи, аналогичные Model::find().

Возвращает

строка
Строка, содержащая SQL запрос.

См. также

DboSource::buildStatement()

buildColumn()source public

buildColumn( array $column )

Генерирует строку схемы столбца, соответствующую базе данных.

Параметры

массив $column

Массив, структурированный следующим образом: array('name' => 'value', 'type' => 'value'[, options]), где опции могут быть 'default', 'length', или 'key'.

Возвращает

строка

buildIndex()source public

buildIndex( array $indexes , string $table null )

Форматирует индексы для создания таблицы.

Параметры

массив $indexes

Индексы для создания.

строка $table необязательно null

Имя таблицы.

Возвращает

массив

buildJoinStatement()source public

buildJoinStatement( array $join )

Создаёт и генерирует условие JOIN из массива. Обрабатывает окончательную очистку перед преобразованием.

Параметры

массив $join

Массив, определяющий условие JOIN в запросе.

Возвращает

строка
Условие JOIN SQL, которое будет использоваться в запросе.

См. также

DboSource::renderJoinStatement()
DboSource::buildStatement()

buildStatement()source public

buildStatement( array $query , Model $Model )

Создаёт и генерирует SQL запрос из массива. Обрабатывает окончательную очистку перед преобразованием.

Параметры

массив $query

Массив, определяющий SQL запрос.

Model $Model

Объект модели, который инициировал запрос.

Возвращает

строка
Исполняемый SQL запрос.

См. также

DboSource::renderStatement()

buildTableParameters()source public

buildTableParameters( array $parameters , string $table null )

Форматирует параметры для создания таблицы

Параметры

массив $parameters

Параметры для создания SQL.

строка $table необязательно null

Имя таблицы.

Возвращает

массив

cacheMethod()source public

cacheMethod( string $method , string $key , mixed $value null )

Кэширует значение в methodCaches. Учитывает значение DboSource::$cacheMethods. Возвращает значение из кэша, если $value равно null.

Если кэширование отключено и попытка записи, то возвращается $value. Чтение возвращает значение или null.

Параметры

строка $method

Имя кэшируемого метода.

строка $key

Имя ключа для операции кэширования.

смешанное $value необязательно null

Значение для кэширования в памяти.

Возвращает

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

calculate()source public

calculate( Model $Model , string $func , array $params array() )

Возвращает SQL вычисление, например COUNT() или MAX()

Параметры

Model $Model

Модель для получения вычисляемого поля.

строка $func

Нижняя регистром имя SQL функции, например 'count' или 'max'

массив $params необязательно массив()

Параметры функции (любые значения должны быть вручную заключены в кавычки)

Возвращает

строка
SQL функция вычисления

close()source public

close( )

Отключает базу данных, закрывает подключение и отмечает подключение как закрытое.

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

DataSource::close()

commit()source public

commit( )

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

Возвращает

boolean

Истина при успехе, ложь при неудаче (т.е. если база данных/модель не поддерживает транзакции или транзакция не начата).

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

DataSource::commit()

conditionKeysToString()source public

conditionKeysToString( array $conditions , boolean $quoteValues true , Model $Model null )

Создаёт условие WHERE, анализируя заданный массив условий. Используется DboSource::conditions().

Параметры

массив $conditions

Массив или строка условий

логическое $quoteValues необязательно true

Если true, значения должны быть заключены в кавычки

Model $Model необязательно null

Ссылка на экземпляр модели, выполняющий запрос

Возвращает

строка
SQL фрагмент

conditions()source public

conditions( mixed $conditions , boolean $quoteValues true , boolean $where true , Model $Model null )

Создаёт условие WHERE, анализируя предоставленные данные условий. Если предоставлены массив или строка условий, эти условия будут обработаны и взяты в кавычки. Если предоставлено булево значение, оно будет преобразовано в целое число как условие. Null вернёт 1 = 1.

Результаты этого метода сохраняются в кэше памяти. Это повышает производительность, но из-за использования алгоритма хеширования могут возникать коллизии. Установка DboSource::$cacheMethods в false отключит кэш памяти.

Параметры

mixed $conditions

Массив или строка условий или любое значение.

boolean $quoteValues необязательно true

Если true, значения должны быть взяты в кавычки

boolean $where необязательно true

Если true, к результату будет добавлено "WHERE "

Model $Model необязательно null

Ссылка на экземпляр объекта Model, выполняющего запрос

Возвращает

string
SQL фрагмент

create()source public

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

Буква "C" в CRUD

Создаёт новые записи в базе данных.

Параметры

Model $Model

Объект модели, для которой создаётся запись.

array $fields необязательно null

Массив имён полей для вставки. Если null, используется $Model->data для генерации имён полей.

array $values необязательно null

Массив значений с ключами, соответствующими полям. Если null, используется $Model->data для генерации значений.

Возвращает

boolean
Успех

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

DataSource::create()

createSchema()source public

createSchema( CakeSchema $schema , string $tableName null )

Генерирует схему базы данных для заданного объекта Schema.

Параметры

CakeSchema $schema

Экземпляр подкласса CakeSchema.

string $tableName необязательно null

Необязательно. Если указано, генерируется только таблица с данным именем. В противном случае генерируются все таблицы, определённые в схеме.

Возвращает

string

defaultConditions()source public

defaultConditions( Model $Model , string|array|boolean $conditions , boolean $useAlias true )

Создаёт набор стандартных условий из модели, если $conditions равен null или пуст. Если условия предоставлены, они возвращаются. Если модели нет и условия не были предоставлены, возвращается null или false, в зависимости от входного значения.

Параметры

Model $Model

Модель, для которой получаются условия.

string|array|boolean $conditions

Массив условий, строка условий, null или false. Если массив условий или строка условий, эти условия возвращаются. В других случаях проверяется существование модели. Если модели нет, возвращается null или false, в зависимости от входного значения.

boolean $useAlias необязательно true

Использовать псевдонимы модели вместо имён таблиц при генерации условий

Возвращает

mixed
Либо null, false, $conditions или массив стандартных условий для использования.

См. также

DboSource::update()
DboSource::conditions()

delete()source public

delete( Model $Model , mixed $conditions null )

Генерирует и выполняет оператор SQL DELETE. Для баз данных, не поддерживающих псевдонимы в операторах UPDATE.

Параметры

Model $Model

Модель, из которой выполняется удаление.

mixed $conditions необязательно null

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

Возвращает

boolean
Успех

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

DataSource::delete()

disconnect()source public

disconnect( )

Отключается от базы данных.

Возвращает

boolean
Всегда true

dropSchema()source public

dropSchema( CakeSchema $schema , string $table null )

Генерирует оператор "drop table" для заданного объекта Schema.

Параметры

CakeSchema $schema

Экземпляр подкласса CakeSchema.

string $table необязательно null

Необязательно. Если указано, генерируется только таблица с данным именем. В противном случае генерируются все таблицы, определённые в схеме.

Возвращает

string

execute()source public

execute( string $sql , array $options array() , array $params array() )

Выполняет запрос к базе данных с заданным оператором SQL и получает метаданные о результате (затронутые строки, время выполнения, ошибки, количество строк в наборе результатов). Запрос также регистрируется. Если Configure::read('debug') установлено, лог отображается всегда, в противном случае только при ошибках.

Параметры

• log - Выводить ли запрос в лог памяти.

Параметры

string $sql

Оператор SQL

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

Параметры выполнения запроса.

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

Значения, которые должны быть привязаны к запросу.

Возвращает

mixed
Ресурс или объект, представляющий набор результатов, или false при ошибке

expression()source public

expression( string $expression )

Возвращает объект для представления выражения базы данных в запросе. Объекты выражения не проверяются и не экранируются.

Параметры

string $expression

Произвольное выражение SQL, которое нужно вставить в запрос.

Возвращает

stdClass
Объект, представляющий выражение базы данных для использования в запросе

fetchAll()source public

fetchAll( string $sql , array|boolean $params array() , array $options array() )

Возвращает массив всех строк результата для заданного запроса SQL.

Возвращает false, если совпадений нет.

Параметры

• cache - Возвращает кэшированную версию запроса, если она существует и сохраняет результат в кэше. Это кэш неперсистентный и сохраняется только для одного запроса. По умолчанию это значение равно true. Если вы напрямую вызываете этот метод, вы можете отключить кэширование, установив $options в false

Параметры

string $sql

Оператор SQL

array|boolean $params необязательно array()

Либо параметры, которые нужно привязать в качестве значений к оператору SQL, либо булево значение для управления кэшированием запроса.

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

дополнительные параметры для запроса.

Возвращает

boolean|array
Массив строк набора результатов или false, если совпадений нет

fetchAssociated()source public

fetchAssociated( Model $Model , string $query , array $ids )

Получить ассоциированные записи 'hasMany'.

Это просто прокси для поддержания обратной совместимости.

Параметры

Model $Model

Основной объект модели.

string $query

Шаблон запроса ассоциации.

array $ids

Массив идентификаторов связанных записей.

Возвращает

array
Результаты ассоциаций.

См. также

DboSource::_fetchHasMany()

fetchResult()source public

fetchResult( )

Возвращает следующую строку из текущего набора результатов.

Возвращает

boolean

fetchRow()source public

fetchRow( string $sql null )

Возвращает строку из текущего набора результатов в виде массива.

Параметры

string $sql необязательно null

SQL, который нужно выполнить.

Возвращает

array
Выборка строки в виде массива

fetchVirtualField()source public

fetchVirtualField( array $result )

Изменяет массив $result, чтобы разместить виртуальные поля в записи модели, где они должны быть

Параметры

массив $result

$result Ссылка на полученную строку

field()source public

field( string $name , string $sql )

Возвращает одно поле из первой строки результатов запроса для заданного SQL-запроса или false, если пусто.

Параметры

строка $name

Имя поля, которое нужно получить.

строка $sql

SQL-запрос.

Возвращает

mixed
Значение считанного поля или false, если не найдено.

fields()source public

fields( Model $Model , string $alias null , mixed $fields array() , boolean $quote true )

Генерирует список полей SQL-запроса.

Параметры

Model $Model

Модель, для которой нужно получить поля.

строка $alias необязательно null

Псевдоним имени таблицы

смешанный $fields необязательно массив()

Предоставленный список полей.

логический $quote необязательно true

Если false, возвращает массив полей без кавычек

Возвращает

массив

flushMethodCache()source public

flushMethodCache( )

Очищает кэш методов. Эти кэши используются DboSource::name() и DboSource::conditions()

fullTableName()source public

fullTableName( Model|string $model , boolean $quote true , boolean $schema true )

Получает полное имя таблицы, включая префикс

Параметры

Model|строка $model

Объект модели или строка имени таблицы.

логический $quote необязательно true

Нужно ли заключать имя таблицы в кавычки?

логический $schema необязательно true

Включать ли имя схемы?

Возвращает

строка
Полное имя таблицы в кавычках

generateAssociationQuery()source public

generateAssociationQuery( Model $Model , Model|null $LinkModel , string $type , string $association , array $assocData , array $queryData , boolean $external )

Генерирует запрос или часть запроса из одной модели или двух связанных моделей.

Создаёт строку, содержащую шаблон SQL-запроса.

Параметры

Model $Model

Основной объект модели.

Model|null $LinkModel

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

строка $type

Тип связи, один из типов связей модели, например, hasMany.

строка $association

Имя связи.

массив $assocData

Данные связи.

массив $queryData

$queryData Массив информации о запросе, содержащий ключи, аналогичные Model::find().

логический $external

Связан ли запрос к внешнему источнику данных.

Возвращает

смешанный

Строка, представляющая запрос. True, если $external равен false, а связь $type равна 'hasOne' или 'belongsTo'.

getConnection()source public

getConnection( )

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

Возвращает

PDO

getConstraint()source public

getConstraint( string $type , Model $Model , Model $LinkModel , string $association , array $assocData , string $association2 null )

Возвращает массив условий для ограничения между двумя моделями.

Параметры

строка $type

Тип связи.

Model $Model

Основной объект модели.

Model $LinkModel

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

строка $association

Имя связи.

массив $assocData

Данные связи.

строка $association2 необязательно null

Имя связи HABTM.

Возвращает

массив
Массив условий, определяющих ограничение между $Model и $LinkModel.

getLog()source public

getLog( boolean $sorted false , boolean $clear true )

Получить журнал запросов в виде массива.

Параметры

логический $sorted необязательно false

Получить запросы, отсортированные по времени выполнения, по умолчанию false.

логический $clear необязательно true

Если True, существующий журнал будет очищен.

Возвращает

массив
Массив запущенных запросов в виде массива

getQueryCache()source public

getQueryCache( string $sql , array $params array() )

Возвращает результат SQL-запроса, если он уже кэширован

Параметры

строка $sql

SQL-запрос

массив $params необязательно массив()

параметры запроса привязаны в качестве значений

Возвращает

смешанный
результаты запроса, если он кэширован, в противном случае false

getVersion()source public

getVersion( )

Получает строку версии сервера базы данных

Возвращает

строка
Версия базы данных

group()source public

group( string|array $fields , Model $Model null )

Создаёт SQL-оператор GROUP BY.

Параметры

строка|массив $fields

Поля GROUP BY

Model $Model необязательно null

Модель, для которой нужно получить поля GROUP BY.

Возвращает

строка
Оператор GROUP BY или null.

hasAny()source public

hasAny( Model $Model , string $sql )

Проверяет, содержит ли указанная таблица запись, соответствующую заданному SQL-запросу

Параметры

Model $Model

Модель для поиска

строка $sql

SQL-оператор WHERE (только условие, без части "WHERE")

Возвращает

логический
True, если в таблице есть соответствующая запись, иначе false

hasResult()source public

hasResult( )

Проверяет, является ли результат допустимым

Возвращает

логический
True, если результат допустим, иначе false

identifier()source public

identifier( string $identifier )

Возвращает объект для представления идентификатора базы данных в запросе. Объекты выражений не проверяются и не экранируются.

Параметры

строка $identifier

SQL-выражение, используемое в качестве идентификатора

Возвращает

stdClass
Объект, представляющий идентификатор базы данных для использования в запросе

index()source public

index( string $model )

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

Параметры

строка $model

Имя модели для проверки

Возвращает

массив
Поля в таблице. Ключи — столбец и уникальность

insertMulti()source public

insertMulti( string $table , array $fields , array $values )

Вставка нескольких значений в таблицу

Параметры

строка $table

Таблица, в которую происходит вставка.

массив $fields

Массив имен полей/столбцов, которые будут вставлены.

массив $values

Массив значений для вставки. Значения должны быть массивом строк. Каждая строка должна содержать значения, индексированные по имени столбца. Каждая строка должна содержать значения в том же порядке, что и в $fields.

Возвращает

boolean

introspectType()source public

introspectType( string $value )

Определяет тип данных массива

Параметры

строка $value

Значение для определения типа данных.

Возвращает

строка

isConnected()source public

isConnected( )

Проверяет, подключен ли источник к базе данных.

Возвращает

boolean
True, если база данных подключена, иначе false

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

смешанный $source необязательный null

Источник для проверки.

Возвращает

целое число
Количество затронутых строк

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

Возвращает отформатированное сообщение об ошибке от предыдущей операции с базой данных.

Параметры

PDOStatement $query необязательный null

Запрос для извлечения ошибки, если таковая имеется

Возвращает

строка
Сообщение об ошибке с номером ошибки

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

смешанный $source необязательный null

Источник для получения ID.

Возвращает

смешанный

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

Возвращает количество строк в предыдущем наборе результатов. Если предыдущий набор результатов отсутствует, возвращает false.

Параметры

смешанный $source необязательный null

Не используется

Возвращает

целое число
Количество строк в наборе результатов

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

DataSource::lastNumRows()

length()source public

length( string $real )

Возвращает длину описания столбца из базы данных или null, если длина не задана

Параметры

строка $real

Действительный тип столбца уровня базы данных (например, "varchar(255)")

Возвращает

смешанный
Целое число или строка, представляющая длину столбца, или null для неизвестной длины.

limit()source public

limit( integer $limit , integer $offset null )

Возвращает ограничение в нужном формате для конкретной базы данных.

Параметры

целое число $limit

Ограничение на возвращаемые результаты

целое число $offset необязательный null

Смещение, с которого начинаются результаты

Возвращает

строка
SQL ограничение/смещение

logQuery()source public

logQuery( string $sql , array $params array() )

Логирование заданного SQL запроса.

Параметры

строка $sql

SQL запрос

массив $params необязательный array()

Значения, связанные с запросом (подготовленные запросы)

name()source public

name( mixed $data )

Возвращает имя $data в кавычках для использования в SQL-запросе. Удаляет поля из SQL-функций перед добавлением кавычек.

Результаты этого метода хранятся в кэше памяти. Это повышает производительность, но из-за использования алгоритма хэширования могут возникать коллизии. Установка DboSource::$cacheMethods в false отключит кэш памяти.

Параметры

смешанный $data

Строка со столбцом, который нужно привести в кавычки. Массив столбцов, которые нужно привести в кавычки, или объект из DboSource::expression() или DboSource::identifier()

Возвращает

строка
SQL поле

nestedTransactionSupported()source public

nestedTransactionSupported( )

Проверка поддержки вложенных транзакций

Возвращает

boolean

order()source public

order( array|string $keys , string $direction 'ASC' , Model $Model null )

Возвращает ORDER BY предложение в виде строки.

Параметры

массив|строка $keys

Ссылка на поле (например, Post.title)

строка $direction необязательный 'ASC'

Направление (ASC или DESC)

Model $Model необязательный null

Ссылка на модель (используется для поиска виртуального поля)

Возвращает

строка
ORDER BY предложение

prepareFields()source public

prepareFields( Model $Model , array $queryData )

Подготавливает поля, необходимые для SQL-запроса.

Когда поля не заданы, возвращаются все поля $Model.

Параметры

Model $Model

Модель для подготовки.

массив $queryData

Массив данных запроса, содержащий ключи, аналогичные ключам Model::find().

Возвращает

массив
Массив, содержащий SQL-поля.

query()source public

query( )

Абстракция запросов к источнику данных

Возвращает

ресурс
Идентификатор ресурса результата.

queryAssociation()source public

queryAssociation( Model $Model , Model $LinkModel , string $type , string $association , array $assocData , array $queryData , boolean $external , array $resultSet , integer $recursive , array $stack )

Запрос ассоциаций.

Используется для получения результатов на рекурсивных моделях.

• Ассоциации 'hasMany' без установленного ограничения: Выборка, фильтрация и слияние выполняются рекурсивно для каждого уровня.

• Ассоциации 'hasAndBelongsToMany': Выборка и фильтрация выполняются без влияния установленного (рекурсивного) уровня.

Параметры

Model $Model

Основной объект модели.

Model $LinkModel

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

строка $type

Тип ассоциации, один из типов ассоциации модели, например, hasMany.

строка $association

Имя ассоциации.

массив $assocData

Данные ассоциации.

массив $queryData

$queryData Массив данных запроса, содержащий ключи, аналогичные ключам Model::find().

boolean $external

Признак того, является ли запрос ассоциации для внешнего источника данных.

массив $resultSet

$resultSet Существующие результаты.

целое число $recursive

Количество уровней ассоциации.

массив $stack

Список соединенных моделей.

Возвращает

смешанный

Исключения

CakeException
при невозможности создания результатов.

rawQuery()source public

rawQuery( string $sql , array $params array() )

Выполняет заданное SQL-утверждение.

Параметры

строка $sql

SQL-утверждение

массив $params необязательно array()

Дополнительные параметры для запроса.

Возвращает

смешанный
Ресурс или объект, представляющий результат набора, или false при ошибке

read()source public

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

«Чтение» в CRUD

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

Параметры

Model $Model

Объект модели, для которого предназначен запрос.

массив $queryData необязательно array()

Массив данных запроса, содержащий ключи, аналогичные Model::find().

целое число $recursive необязательно null

Количество уровней ассоциации

Возвращает

смешанный
false при ошибке/неудаче. Массив результатов при успехе.

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

Считывание дополнительных параметров таблицы

Параметры

строка $name

Имя таблицы для считывания.

Возвращает

массив

reconnect()source public

reconnect( array $config array() )

Подключение к серверу базы данных с необязательными новыми настройками

Параметры

массив $config необязательно array()

Массив, определяющий новые параметры конфигурации

Возвращает

логическое
Истина при успехе, ложь при ошибке

renderJoinStatement()source public

renderJoinStatement( array $data )

Генерирует окончательное SQL-утверждение JOIN

Параметры

массив $data

Данные для генерации утверждения JOIN.

Возвращает

строка

renderStatement()source public

renderStatement( string $type , array $data )

Генерирует окончательное SQL-утверждение, объединяя составляющие части в правильном порядке

Параметры

строка $type

тип выполняемого запроса. Например, select, create, update, delete, схема, alter.

массив $data

Массив данных для вставки в запрос.

Возвращает

строка|null
Сгенерированное SQL-выражение для выполнения, иначе null.

resetSequence()source public

resetSequence( string $table , string $column )

Сброс последовательности на основе значения MAX() для столбца. Полезно для сброса последовательностей после использования insertMulti().

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

Параметры

строка $table

Имя таблицы для обновления.

строка $column

Столбец, используемый при сбросе значения последовательности.

Возвращает

логическое
Успех.

resolveKey()source public

resolveKey( Model $Model , string $key , string $assoc null )

Возвращает ключ, отформатированный как строка Model.fieldname (например, Post.title или Country.name).

Параметры

Model $Model

Модель для получения ключа.

строка $key

Поле ключа.

строка $assoc необязательно null

Имя ассоциации.

Возвращает

строка

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

DataSource::resolveKey()

rollback()source public

rollback( )

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

Возвращает

логическое

Истина при успехе, ложь при неудаче (т. е. если база данных/модель не поддерживает транзакции или транзакция не начата).

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

Выводит содержимое журнала запросов. Если находится в среде, отличной от CLI, элемент sql_log будет отображён и выведен. Если находится в среде CLI, генерируется текстовый журнал.

Параметры

логическое $sorted необязательно false

Получить запросы, отсортированные по времени выполнения, по умолчанию false.

truncate()source public

truncate( Model|string $table )

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

Параметры

Model|строка $table

Строка или класс модели, представляющий таблицу, которая должна быть обнулена

Возвращает

логическое
SQL-утверждение TRUNCATE TABLE, false, если не применимо.

update()source public

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

Генерирует и выполняет SQL-утверждение UPDATE для заданной модели, полей и значений. Для баз данных, которые не поддерживают псевдонимы в запросах UPDATE.

Параметры

Model $Model

Модель для обновления.

массив $fields необязательно array()

Поля для обновления

массив $values необязательно null

Значения полей.

смешанный $conditions необязательно null

Условие обновления. Когда $values не пустой, значения не будут взяты в кавычки.

Возвращает

логическое
Успех

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

DataSource::update()

value()source public

value( string $data , string $column null , boolean $null true )

Возвращает цитированную и экранированную строку $data для использования в SQL-утверждении.

Параметры

строка $data

Строка, которая должна быть подготовлена для использования в SQL-утверждении

строка $column необязательно null

Тип данных столбца, в который будут вставлены эти данные.

логическое $null необязательно true

Столбец допускает значения NULL

Возвращает

строка
Цитированные и экранированные данные

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

строка $object

Имя объекта (модели) для кэширования

смешанный $data необязательно null

Описание модели, обычно строка или массив

Возвращает

смешанный

column()source public

column( string $real )

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

Параметры

строка $real

Реальный тип столбца (например, "varchar(255)")

Возвращает

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

describe()source public

describe( Model|string $model )

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

Параметры

Model|строка $model

Модель для описания.

Возвращает

массив|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 при ошибке.

listSources()source public

listSources( mixed $data null )

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

Параметры

mixed $data необязательно null

Не используется в этом классе.

Возвращает

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

setConfig()source public

setConfig( array $config array() )

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

Параметры

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

Массив конфигурации

_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 для значений.

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 при успехе/неудачи или содержимое рендерного действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

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

Возвращает

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

null

false

array()

200

null

array()

array(
    'conditions' => array(),
    'fields' => null,
    'table' => null,
    'alias' => null,
    'order' => null,
    'limit' => null,
    'joins' => array(),
    'group' => null,
    'offset' => null
)

null

array('and', 'or', 'not', 'and not', 'or not', 'xor', '||', '&&')

array('like', 'ilike', 'rlike', 'or', 'not', 'in', 'between', 'regexp', 'similar to')

null

'AS '

true

null

"Database Data Source"

null

array()

false

array('PRI' => 'primary', 'MUL' => 'index', 'UNI' => 'unique')

array()

null

null

array()

null

false

'__'