Класс 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 + port.
• 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 необязательно массив()

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

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

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

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

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

Возвращает

массив

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

DboSource::update()

value()source public

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

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

Параметры

строка $data

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

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

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

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

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

Возвращает

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

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

DboSource::value()

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

Начало вложенной транзакции

Возвращает

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 необязательно массив()

Список параметров для привязки к запросу

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

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

Возвращает

смешанное

PDOStatement, если запрос выполняется без проблем, true как результат успешного, false при ошибке, запрос не возвращает строк, например, оператор 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 необязательно массив()

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

Возвращает

массив
Массив результатов, прошедших фильтрацию через $Model->afterFind.

_filterResultsInclusive()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

Список классов для фильтрации.

Возвращает

массив
Массив результатов, прошедших фильтрацию через $Model->afterFind.

_getJoins()source protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

Возвращает

массив

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

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

Параметры

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 )

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

Параметры

array $data

Данные для удаления метаданных.

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

array

_writeQueryCache()source protected

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

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

Параметры

string $sql

Запрос SQL

mixed $data

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

array $params optional array()

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

begin()source public

begin( )

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

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

boolean

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

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

DataSource::begin()

boolean()source public

boolean( mixed $data , boolean $quote false )

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

Параметры

mixed $data

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

boolean $quote optional 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 )

Кэширование значения в методCaches. Учитывает значение 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/ru/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

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

строка|массив|логическое значение $conditions

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

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

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

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

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

См. также

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

disconnect()source public

disconnect( )

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

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

булево значение
Всегда true

dropSchema()source public

dropSchema( CakeSchema $schema , string $table null )

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

Параметры

CakeSchema $schema

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

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

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

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

строка

execute()source public

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

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

Параметры

• log - Выполнять ли логирование запроса в журнал.

Параметры

строка $sql

SQL-заявление

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

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

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

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

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

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

expression()source public

expression( string $expression )

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

Параметры

строка $expression

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

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

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

fetchAll()source public

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

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

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

Параметры

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

Параметры

строка $sql

SQL-заявление

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

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

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

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

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

булево значение|массив
Массив строк набора результатов или false, если строки не найдены

fetchAssociated()source public

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

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

Это всего лишь прокси для сохранения обратной совместимости.

Параметры

Model $Model

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

строка $query

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

массив $ids

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

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

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

См. также

DboSource::_fetchHasMany()

fetchRow()source public

fetchRow( string $sql null )

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

Параметры

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

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

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

массив
Полученная строка в виде массива

fetchVirtualField()source public

fetchVirtualField( array $result )

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

Параметры

массив $result

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

field()source public

field( string $name , string $sql )

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

Параметры

строка $name

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

строка $sql

SQL-запрос.

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

смешанный тип
Значение считанного поля или 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()

flushQueryCache()source public

flushQueryCache( )

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

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

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

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 optional null

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

Возвращает

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

getLog()source public

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

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

Параметры

boolean $sorted optional false

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

boolean $clear optional true

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

Возвращает

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

getQueryCache()source public

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

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

Параметры

string $sql

SQL-запрос.

array $params optional 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 optional 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

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 optional null

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

Возвращает

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

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

PDOStatement $query optional null

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

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

mixed $source optional null

Источник, для которого получить идентификатор.

Возвращает

mixed

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

mixed $source optional 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 )

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

Параметры

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

Предел возвращаемых результатов

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

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

Возвращает

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

logQuery()source public

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

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

Параметры

строка $sql

SQL оператор

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

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

name()source public

name( mixed $data )

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

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

Параметры

смешанный $data

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

Возвращает

строка
SQL поле

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

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

Возвращает

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

query()source public

query( )

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

Возвращает

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

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 - массив информации queryData, содержащий ключи, аналогичные Model::find().

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

Включено или нет внешнее соединение для запроса ассоциации.

массив $resultSet

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

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

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

массив $stack

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

Возвращает

смешанный

Исключения

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

rawQuery()source public

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

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

Параметры

строка $sql

SQL оператор

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

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

Возвращает

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

read()source public

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

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

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

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

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

строка $name

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

Возвращает

массив

reconnect()source public

reconnect( array $config array() )

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

Параметры

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

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

Возвращает

логическое значение
True при успехе, false при неудаче

renderJoinStatement()source public

renderJoinStatement( array $data )

Отображает окончательный SQL оператор JOIN

Параметры

массив $data

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

Возвращает

строка

renderStatement()source public

renderStatement( string $type , array $data )

Отображает окончательный SQL оператор, объединяя составные части в правильном порядке

Параметры

строка $type

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

массив $data

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

Возвращает

строка или null
Отображенный SQL оператор для выполнения, в противном случае null.

resetSequence()source public

resetSequence( string $table , string $column )

Сброс последовательности на основе значения MAX() $column. Полезно для сброса последовательностей после использования 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( )

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

Возвращает

boolean

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

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

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

Параметры

boolean $sorted необязательный false

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

truncate()source public

truncate( Model|string $table )

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

Параметры

Model|string $table

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

Возвращает

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

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

string $object

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

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

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

Возвращает

mixed

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

setConfig()source public

setConfig( array $config array() )

Устанавливает конфигурацию для DataSource. Объединяет информацию $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( )

Преобразование 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'),
    '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', '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'),
)