Класс Mysql

_alterIndexes()source protected

_alterIndexes( string $table , array $indexes )

Генерирует операторы изменения индексов MySQL для таблицы.

Параметры

строка $table

Таблица, для которой нужно изменить индексы

массив $indexes

Индексы для добавления и удаления

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

массив
Операторы изменения индексов

_alterTableParameters()source protected

_alterTableParameters( string $table , array $parameters )

Генерирует операторы изменения параметров таблицы MySQL для таблицы.

Параметры

строка $table

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

массив $parameters

Параметры для добавления и удаления.

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

массив
Массив операторов изменения свойств таблицы.

_buildIndexSubPart()source protected

_buildIndexSubPart( array $lengths , string $column )

Форматирует длину для текстовых индексов

Параметры

массив $lengths

Массив длин для одного индекса

строка $column

Столбец, для которого нужно сгенерировать длину индекса

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

строка
Отформатированная часть длины поля индекса

_deleteNeedsComplexConditions()source protected

_deleteNeedsComplexConditions( Model $model , mixed $conditions )

Проверяет, нужны ли сложные условия для удаления с заданными условиями.

Параметры

Model $model

Модель, из которой нужно удалить.

смешанный $conditions

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

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

логическое значение
Нужны ли сложные условия

_dropTable()source protected

_dropTable( type $table )

Создать оператор «удаления таблицы» для заданной таблицы

Параметры

type $table

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

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

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

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

DboSource::_dropTable()

_unsigned()source protected

_unsigned( string $real )

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

Параметры

string $real

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

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

boolean
Истина, если столбец беззнаковый, иначе ложь

alterSchema()source public

alterSchema( array $compare , string $table null )

Генерировать синтаксис MySQL Alter Table для заданного сравнения схем

Параметры

array $compare

Результат CakeSchema::compare()

string $table optional null

Имя таблицы.

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

array
Массив операторов изменения.

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

DboSource::alterSchema()

buildIndex()source public

buildIndex( array $indexes , string $table null )

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

Параметры

array $indexes

Массив индексов для генерации SQL

string $table optional null

Необязательное имя таблицы, не используется

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

array
Массив SQL-операторов для индексов

См. также

DboSource::buildIndex()

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

DboSource::buildIndex()

column()source public

column( string $real )

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

Параметры

string $real

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

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

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

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

DataSource::column()

connect()source public

connect( )

Подключение к базе данных с использованием опций в заданном массиве конфигурации.

MySQL поддерживает несколько дополнительных опций, которых нет у других драйверов:

• unix_socket Указывает путь к файлу сокета MySQL. Можно использовать вместо host + порт.
• ssl_key Файл ключа SSL для подключения через SSL. Должен использоваться совместно с ssl_cert.
• ssl_cert Сертификат SSL для использования при подключении через SSL. Должен использоваться совместно с ssl_key.
• ssl_ca Удостоверяющий центр для подключений SSL.

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

boolean
Истина, если база данных подключена, иначе ложь

Выбрасывает

MissingConnectionException

delete()source public

delete( Model $model , mixed $conditions null )

Генерирует и выполняет оператор SQL DELETE для заданного id/условий в заданной модели.

Параметры

Model $model

Модель, из которой нужно удалить.

mixed $conditions optional null

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

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

boolean
Успех

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

DboSource::delete()

describe()source public

describe( Model|string $model )

Возвращает массив полей в заданном имени таблицы.

Параметры

Model|string $model

Имя таблицы базы данных для проверки или экземпляр модели

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

array
Поля в таблице. Ключи — имя и тип

Выбрасывает

CakeException

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

DataSource::describe()

enabled()source public

enabled( )

Проверка, установлен/загружен ли расширение MySQL

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

boolean

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

DataSource::enabled()

fetchResult()source public

fetchResult( )

Извлечение следующей строки из текущего набора результатов

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

mixed
Массив с извлеченными результатами, сопоставленными с именами столбцов, или ложь, если больше нет результатов для извлечения

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

DboSource::fetchResult()

getCharsetName()source public

getCharsetName( string $name )

Запрос кодировки символов по кодировке

Параметры

string $name

Имя кодировки

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

string
Имя кодировки символов

getEncoding()source public

getEncoding( )

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

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

string
Кодировка базы данных

getSchemaName()source public

getSchemaName( )

Получение имени схемы

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

string
Имя схемы

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

DataSource::getSchemaName()

index()source public

index( string $model )

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

Параметры

string $model

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

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

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

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

DboSource::index()

insertMulti()source public

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

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

Параметры

string $table

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

array $fields

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

array $values

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

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

boolean

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

DboSource::insertMulti()

listDetailedSources()source public

listDetailedSources( string $name null )

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

Параметры

string $name optional null

Имя таблицы, для получения параметров.

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

array
Массив имён таблиц в базе данных

listSources()source public

listSources( mixed $data null )

Возвращает массив источников (таблиц) в базе данных.

Параметры

mixed $data optional null

Список таблиц.

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

array
Массив имён таблиц в базе данных

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

DataSource::listSources()

nestedTransactionSupported()source public

nestedTransactionSupported( )

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

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

boolean

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

DboSource::nestedTransactionSupported()

resultSet()source public

resultSet( PDOStatement $results )

Строит отображение столбцов, содержащихся в результате

Параметры

PDOStatement $results

Результаты для форматирования.

setEncoding()source public

setEncoding( string $enc )

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

Параметры

строка $enc

Кодировка базы данных

Возвращает

boolean

update()source public

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

Генерирует и выполняет оператор SQL UPDATE для заданной модели, полей и значений.

Параметры

Model $model

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

массив $fields optional array()

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

массив $values optional null

Значения для установки.

смешанное $conditions optional null

Условия для использования.

Возвращает

массив

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

DboSource::update()

value()source public

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

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

Параметры

строка $data

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

строка $column optional null

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

логическое значение $null optional true

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

Возвращает

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

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

DboSource::value()

__construct()source public

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

Конструктор

Параметры

массив $config optional null

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

логическое значение $autoConnect optional true

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

Исключения

MissingConnectionException
если подключение не может быть установлено.

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

DataSource::__construct()

__destruct()source public

__destruct( )

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

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

DataSource::__destruct()

_beginNested()source protected

_beginNested( )

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

Возвращает

boolean

_buildFieldParameters()source protected

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

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

Параметры

строка $columnString

Частично созданная строка столбца

массив $columnData

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

строка $position

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

Возвращает

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

_commitNested()source protected

_commitNested( )

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

Возвращает

boolean

_constructVirtualFields()source protected

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

Преобразует виртуальные поля модели в выражения SQL для последующего извлечения

Параметры

Model $Model

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

строка $alias

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

массив $fields

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

Возвращает

массив

_execute()source protected

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

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

Параметры

строка $sql

Оператор SQL

массив $params optional array()

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

массив $prepareOptions optional array()

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

Возвращает

смешанное

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

Исключения

PDOException

_fetchHasAndBelongsToMany()source protected

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

Получить ассоциации 'hasAndBelongsToMany'.

Параметры

Model $Model

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

строка $query

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

массив $ids

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

строка $association

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

Возвращает

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

_fetchHasMany()source protected

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

Получить ассоциации 'hasMany'.

Параметры

Model $Model

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

строка $query

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

массив $ids

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

Возвращает

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

_filterResults()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

массив $filtered optional array()

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

Возвращает

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

_filterResultsInclusive()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

массив $toBeFiltered optional array()

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

Возвращает

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

_getJoins()source protected

_getJoins( Model $Model )

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

Параметры

Model $Model

Модель для получения соединений.

Возвращает

массив

_matchRecords()source protected

_matchRecords( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

mixed $conditions необязательно 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 необязательно 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 необязательно null

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

Возвращает

string

_prepareUpdateFields()source protected

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

Цитирует и подготавливает поля и значения для оператора SQL UPDATE

Параметры

Model $Model

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

array $fields

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

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

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

boolean $alias необязательно 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 )

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

Параметры

array $data

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

Возвращает

array

_writeQueryCache()source protected

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

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

Параметры

string $sql

Запрос SQL

mixed $data

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

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

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

begin()source public

begin( )

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

Возвращает

boolean

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

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

DataSource::begin()

boolean()source public

boolean( mixed $data , boolean $quote false )

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

Параметры

mixed $data

Значение для перевода

boolean $quote необязательно false

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

Возвращает

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

buildAssociationQuery()source public

buildAssociationQuery( Model $Model , array $queryData )

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

Это просто удобный обертка для DboSource::buildStatement().

Параметры

Model $Model

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

array $queryData

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

Возвращает

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

См. также

DboSource::buildStatement()

buildColumn()source public

buildColumn( array $column )

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

Параметры

array $column

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

Возвращает

string

buildJoinStatement()source public

buildJoinStatement( array $join )

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

Параметры

array $join

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

Возвращает

string
Условие 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 при ошибке или значение, если оно установлено.

cacheMethodFilter()source public

cacheMethodFilter( string $method , string $key , mixed $value )

Фильтрует результаты name и fields. Если фильтр для данного метода не возвращает true, результат не добавляется в кэш памяти.

Примеры:

// For method fields, do not cache values that contain floats
if ($method === 'fields') {
    $hasFloat = preg_grep('/(\d+)?\.\d+/', $value);

    return count($hasFloat) === 0;
}

return true;

// For method name, do not cache values that have the name created
if ($method === 'name') {
    return preg_match('/^`created`$/', $value) !== 1;
}

return true;

// For method name, do not cache values that have the key 472551d38e1f8bbc78d7dfd28106166f
if ($key === '472551d38e1f8bbc78d7dfd28106166f') {
    return false;
}

return true;

Параметры

строка $method

Имя метода, который кэшируется.

строка $key

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

смешанное $value

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

Возвращает

логическое
Следует ли кэшировать

cacheMethodHasher()source public

cacheMethodHasher( string $value )

Хеширует заданное значение.

Кэширование методов использует md5 (по умолчанию) для создания ключей кэша. Если у вас есть проблемы с коллизиями, попробуйте другой алгоритм хеширования или установите DboSource::$cacheMethods в false.

Параметры

строка $value

Значение для хеширования

Возвращает

строка
Хешированное значение

См. также

http://php.net/manual/en/function.hash-algos.php
http://softwareengineering.stackexchange.com/questions/49550/which-hashing-algorithm-is-best-for-uniqueness-and-speed

calculate()source public

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

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

Параметры

Model $Model

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

строка $func

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

массив $params дополнительно array()

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

Возвращает

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

close()source public

close( )

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

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

DataSource::close()

commit()source public

commit( )

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

Возвращает

логическое

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

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

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 отключит кэш памяти.

Параметры

смешанное $conditions

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

логическое $quoteValues дополнительно true

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

логическое $where дополнительно true

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

Model $Model дополнительно null

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

Возвращает

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

create()source public

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

Операция "C" в CRUD

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

Параметры

Model $Model

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

массив $fields дополнительно null

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

массив $values дополнительно null

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

Возвращает

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

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

DataSource::create()

createSchema()source public

createSchema( CakeSchema $schema , string $tableName null )

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

Параметры

CakeSchema $schema

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

строка $tableName дополнительно null

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

Возвращает

строка

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()

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()

fetchRow()source public

fetchRow( string $sql null )

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

Параметры

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

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

Возвращает

array
Извлечённая строка в виде массива

fetchVirtualField()source public

fetchVirtualField( array $result )

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

Параметры

array $result

$result Ссылка на извлечённую строку

field()source public

field( string $name , string $sql )

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

Параметры

string $name

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

string $sql

SQL-запрос.

Возвращает

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

fields()source public

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

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

Параметры

Model $Model

Модель, для которой требуются поля.

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

Алиас имени таблицы

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

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

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

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

Возвращает

array

flushMethodCache()source public

flushMethodCache( )

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

flushQueryCache()source public

flushQueryCache( )

Очищает кэш запросов.

fullTableName()source public

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

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

Параметры

Model|string $model

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

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

Требуется ли имя таблицы в кавычках.

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

Требуется ли включить имя схемы.

Возвращает

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

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

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

string $type

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

string $association

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

array $assocData

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

array $queryData

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

boolean $external

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

Возвращает

mixed

Строка, представляющая запрос. 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 )

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

Параметры

string $type

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

Model $Model

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

Model $LinkModel

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

string $association

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

array $assocData

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

string $association2 опционально null

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

Возвращает

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

getLockingHint()source public

getLockingHint( mixed $mode )

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

В настоящее время этот метод возвращает только FOR UPDATE, когда режим установлен на true.

Параметры

mixed $mode

Режим блокировки

Возвращает

string|null
Оператор FOR UPDATE или null

getLog()source public

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

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

Параметры

boolean $sorted опционально false

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

boolean $clear опционально true

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

Возвращает

array
Массив выполненных запросов

getQueryCache()source public

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

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

Параметры

string $sql

SQL-запрос

array $params опционально array()

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

Возвращает

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

getVersion()source public

getVersion( )

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

Возвращает

string
Версия базы данных

group()source public

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

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

Параметры

string|array $fields

Поля GROUP BY

Model $Model опционально null

Модель для получения полей GROUP BY.

Возвращает

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

hasAny()source public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

string $sql

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

Возвращает

boolean
True, если таблица содержит соответствующую запись, иначе false

hasResult()source public

hasResult( )

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

Возвращает

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

having()source public

having( mixed $fields , boolean $quoteValues true , Model $Model null )

Создает SQL-оператор HAVING.

Параметры

mixed $fields

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

boolean $quoteValues опционально true

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

Model $Model опционально null

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

Возвращает

string|null
Оператор HAVING или null

identifier()source public

identifier( string $identifier )

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

Параметры

string $identifier

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

Возвращает

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

introspectType()source public

introspectType( string $value )

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

Параметры

string $value

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

Возвращает

string

isConnected()source public

isConnected( )

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

Возвращает

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

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

mixed $source опционально null

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

Возвращает

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

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

PDOStatement $query опционально null

запрос, из которого необходимо извлечь ошибку, если она есть

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

mixed $source опционально null

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

Возвращает

mixed

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

length()source public

length( string $real )

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

Параметры

string $real

Тип колонки на уровне базы данных (например, "varchar(255)")

Возвращает

mixed
Целое число или строка, представляющая длину колонки, или null, если длина неизвестна.

limit()source public

limit( integer $limit , integer $offset null )

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

Параметры

integer $limit

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

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

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

Возвращает

string
SQL оператор ограничения/смещения

logQuery()source public

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

Записывает заданный SQL запрос.

Параметры

string $sql

SQL оператор

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

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

name()source public

name( mixed $data )

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

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

Параметры

mixed $data

Строка с полем для присвоения кавычек, массив полей для присвоения кавычек или объект из DboSource::expression() или DboSource::identifier()

Возвращает

string
SQL поле

order()source public

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

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

Параметры

array|string $keys

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

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

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

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

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

Возвращает

string
Оператор ORDER BY

prepareFields()source public

prepareFields( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

array $queryData

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

Возвращает

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

query()source public

query( )

Абстракция запроса DataSource

Возвращает

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

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

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

string $type

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

string $association

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

array $assocData

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

array $queryData

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

boolean $external

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

array $resultSet

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

integer $recursive

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

array $stack

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

Возвращает

mixed

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

CakeException
когда результаты не могут быть созданы.

rawQuery()source public

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

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

Параметры

string $sql

SQL оператор

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

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

Возвращает

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

read()source public

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

Операция "Чтение" в CRUD

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

Параметры

Model $Model

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

array $queryData необязательный array()

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

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

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

Возвращает

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

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

string $name

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

Возвращает

array

reconnect()source public

reconnect( array $config array() )

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

Параметры

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

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

Возвращает

boolean
True при успехе, false при неудаче

renderJoinStatement()source public

renderJoinStatement( array $data )

Генерирует финальный SQL оператор JOIN.

Параметры

array $data

Данные для генерации оператора JOIN.

Возвращает

string

renderStatement()source public

renderStatement( string $type , array $data )

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

Параметры

string $type

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

array $data

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

Возвращает

string|null
Сгенерированный SQL оператор для выполнения, в противном случае null.

resetSequence()source public

resetSequence( string $table , string $column )

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

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

Параметры

строка $table

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

строка $column

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

Возвращает

boolean
Успех.

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( )

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

Возвращает

boolean

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

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

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

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

Возвращает

boolean
SQL-запрос TRUNCATE TABLE, false, если не применимо.

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

строка $object

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

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

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

Возвращает

смешанный

insertQueryData()source public

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

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

Параметры

строка $query

Строка запроса, требующая замены.

массив $data

Массив данных со значениями, которые будут вставлены в placeholders.

строка $association

Имя модели ассоциации, которая заменяется.

Model $Model

Экземпляр модели.

массив $stack

Стек контекста.

Возвращает

смешанный
Строка данных запроса с заменёнными placeholders или false при ошибке.

setConfig()source public

setConfig( array $config array() )

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

Параметры

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

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства.

булево $normalize необязательно true

Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

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

Параметры

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

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

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

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

Параметры

строка $method

Имя вызываемого метода

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

Список параметров для использования при вызове $method

Возвращает

смешанный
Возвращает результат вызова метода

log()source public

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

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

Параметры

строка $msg

Сообщение для журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

null|строка|массив $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.

Параметры

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

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

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

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

Возвращает

смешанный

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

toString()source public

toString( )

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

Возвращает

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

array(
    'persistent' => true,
    'host' => 'localhost',
    'login' => 'root',
    'password' => '',
    'database' => 'cake',
    'port' => '3306',
    'flags' => array()
)

array()

null

true

array(
    'primary_key' => array('name' => 'NOT NULL AUTO_INCREMENT'),
    'string' => array('name' => 'varchar', 'limit' => '255'),
    'text' => array('name' => 'text'),
    'biginteger' => array('name' => 'bigint', 'limit' => '20'),
    'integer' => array('name' => 'int', 'limit' => '11', 'formatter' => 'intval'),
    'smallinteger' => array('name' => 'smallint', 'limit' => '6', 'formatter' => 'intval'),
    'tinyinteger' => array('name' => 'tinyint', 'limit' => '4', 'formatter' => 'intval'),
    'float' => array('name' => 'float', 'formatter' => 'floatval'),
    'decimal' => array('name' => 'decimal', 'formatter' => 'floatval'),
    'datetime' => array('name' => 'datetime', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
    'timestamp' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
    'time' => array('name' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
    'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
    'binary' => array('name' => 'blob'),
    'boolean' => array('name' => 'tinyint', 'limit' => '1')
)

"MySQL DBO Driver"

"`"

array(
    'charset' => array('value' => 'CHARACTER SET', 'quote' => false, 'join' => ' ', 'column' => false, 'position' => 'beforeDefault'),
    'collate' => array('value' => 'COLLATE', 'quote' => false, 'join' => ' ', 'column' => 'Collation', 'position' => 'beforeDefault'),
    'comment' => array('value' => 'COMMENT', 'quote' => true, 'join' => ' ', 'column' => 'Comment', 'position' => 'afterDefault'),
    'unsigned' => array(
        'value' => 'UNSIGNED',
        'quote' => false,
        'join' => ' ',
        'column' => false,
        'position' => 'beforeDefault',
        'noVal' => true,
        'options' => array(true),
        'types' => array('integer', 'smallinteger', 'tinyinteger', 'float', 'decimal', 'biginteger')
    )
)

"`"

array(
    'charset' => array('value' => 'DEFAULT CHARSET', 'quote' => false, 'join' => '=', 'column' => 'charset'),
    'collate' => array('value' => 'COLLATE', 'quote' => false, 'join' => '=', 'column' => 'Collation'),
    'engine' => array('value' => 'ENGINE', 'quote' => false, 'join' => '=', 'column' => 'Engine'),
    'comment' => array('value' => 'COMMENT', 'quote' => true, 'join' => '=', 'column' => 'Comment'),
)