Класс 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 )

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

Параметры

тип $table

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

Возвращает

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

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

DboSource::_dropTable()

_unsigned()source protected

_unsigned( string $real )

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

Параметры

строка $real

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

Возвращает

boolean
True, если столбец беззнаковый, иначе false

alterSchema()source public

alterSchema( array $compare , string $table null )

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

Параметры

массив $compare

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

строка $table optional null

Имя таблицы.

Возвращает

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

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

DboSource::alterSchema()

buildIndex()source public

buildIndex( array $indexes , string $table null )

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

Параметры

массив $indexes

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

строка $table optional null

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

Возвращает

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

См. также

DboSource::buildIndex()

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

DboSource::buildIndex()

column()source public

column( string $real )

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

Параметры

строка $real

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

Возвращает

string
Абстрактный тип столбца (например, "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 для подключений по SSL.

Возвращает

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

Выбрасывает

MissingConnectionException

delete()source public

delete( Model $model , mixed $conditions null )

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

Параметры

Model $model

Модель, из которой необходимо удалить данные.

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

Условие для удаления.

Возвращает

boolean
Успех

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

DboSource::delete()

describe()source public

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

Выбрасывает

CakeException

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

DataSource::describe()

enabled()source public

enabled( )

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

Возвращает

boolean

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

DataSource::enabled()

fetchResult()source public

fetchResult( )

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

Возвращает

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

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

DboSource::fetchResult()

getCharsetName()source public

getCharsetName( string $name )

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

Параметры

строка $name

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

Возвращает

string
Имя набора символов

getEncoding()source public

getEncoding( )

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

Возвращает

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

getSchemaName()source public

getSchemaName( )

Получает имя схемы

Возвращает

string
Имя схемы

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

DataSource::getSchemaName()

index()source public

index( string $model )

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

Параметры

строка $model

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

Возвращает

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

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

DboSource::index()

insertMulti()source public

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

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

Параметры

строка $table

Таблица, в которую вставляются данные.

массив $fields

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

массив $values

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

Возвращает

boolean

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

DboSource::insertMulti()

listDetailedSources()source public

listDetailedSources( string $name null )

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

Параметры

строка $name optional null

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

Возвращает

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

listSources()source public

listSources( mixed $data null )

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

Параметры

смешанное $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.2

Возвращает

массив

_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 boolean в значения базы данных (имитированные) boolean.

Параметры

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' => 'значение', 'type' => 'значение'[, options]), где options может быть 'default', 'length' или 'key'.

Возвращает

string

buildJoinStatement()source public

buildJoinStatement( array $join )

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

Параметры

array $join

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

Возвращает

string
Условие SQL JOIN для использования в запросе.

См.

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

buildStatement()source public

buildStatement( array $query , Model $Model )

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

Параметры

массив $query

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

Model $Model

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

Возвращает

string
Выполнимый SQL-запрос.

См. также

DboSource::renderStatement()

buildTableParameters()source public

buildTableParameters( array $parameters , string $table null )

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

Параметры

массив $parameters

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

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

Имя таблицы.

Возвращает

массив

cacheMethod()source public

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

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

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

Параметры

строка $method

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

строка $key

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

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

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

Возвращает

смешанное
Либо null при ошибке, либо значение, если оно установлено.

calculate()source public

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

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

Параметры

Model $Model

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

строка $func

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

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

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

Возвращает

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

close()source public

close( )

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

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

DataSource::close()

commit()source public

commit( )

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

Возвращает

boolean

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

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

DataSource::commit()

conditionKeysToString()source public

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

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

Параметры

массив $conditions

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

boolean $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

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

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

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

boolean $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 для генерации значений.

Возвращает

boolean
Успех

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

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

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

строка|массив|boolean $conditions

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

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

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

Возвращает

смешанное
Либо 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.

строка $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()

fullTableName()source public

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

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

Параметры

Model|строка $model

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

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

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

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

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

Возвращает

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

generateAssociationQuery()source public

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

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

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

Параметры

Model $Model

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

Model|null $LinkModel

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

строка $type

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

строка $association

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

массив $assocData

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

массив $queryData

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

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

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

Возвращает

смешанный тип

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

getConnection()source public

getConnection( )

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

Возвращает

PDO

getConstraint()source public

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

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

Параметры

строка $type

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

Model $Model

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

Model $LinkModel

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

строка $association

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

массив $assocData

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

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

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

Возвращает

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

getLog()source public

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

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

Параметры

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

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

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

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

Возвращает

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

getQueryCache()source public

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

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

Параметры

строка $sql

SQL-запрос

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

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

Возвращает

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

getVersion()source public

getVersion( )

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

Возвращает

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

group()source public

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

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

Параметры

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

Поля GROUP BY

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

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

Возвращает

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

hasAny()source public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

строка $sql

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

Возвращает

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

hasResult()source public

hasResult( )

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

Возвращает

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

identifier()source public

identifier( string $identifier )

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

Параметры

строка $identifier

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

Возвращает

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

introspectType()source public

introspectType( string $value )

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

Параметры

строка $value

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

Возвращает

строка

isConnected()source public

isConnected( )

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

Возвращает

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

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

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

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

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

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

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

Возвращает

смешанный тип

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

length()source public

length( string $real )

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

Параметры

строка $real

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

Возвращает

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

limit()source public

limit( integer $limit , integer $offset null )

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

Параметры

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

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

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

Смещение для начала результатов

Возвращает

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

logQuery()source public

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

Записывает в журнал указанный SQL-запрос.

Параметры

строка $sql

SQL-оператор

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

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

name()source public

name( mixed $data )

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

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

Параметры

смешанный тип $data

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

Возвращает

строка
SQL-поле

order()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

строка
Оператор ORDER BY

prepareFields()source public

prepareFields( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

массив $queryData

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

Возвращает

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

query()source public

query( )

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

Возвращает

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 Массив информации о запросе, содержащий ключи, аналогичные 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 optional array()

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

Возвращает

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

read()source public

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

«Чтение» в CRUD

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

Параметры

Model $Model

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

array $queryData optional array()

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

integer $recursive optional null

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

Возвращает

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

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

string $name

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

Возвращает

array

reconnect()source public

reconnect( array $config array() )

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

Параметры

array $config optional 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() столбца. Полезно для сброса последовательностей после использования insertMulti().

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

Параметры

string $table

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

string $column

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

Возвращает

boolean
Успех.

resolveKey()source public

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

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

Параметры

Model $Model

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

string $key

Поле ключа.

string $assoc optional null

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

Возвращает

string

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

DataSource::resolveKey()

rollback()source public

rollback( )

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

Возвращает

boolean

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

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

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

Параметры

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

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

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

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

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 и именованных/переданных аргументов.

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

mixed

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

toString()source public

toString( )

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

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

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'),
)