Класс Mysql

_alterIndexesисходный код защищенный

_alterIndexes( string $table , array $indexes )

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

Параметры

строка $table

Таблица для изменения индексов

массив $indexes

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

Возвращает

array
Инструкции по изменению индексов

_alterTableParametersисходный код защищенный

_alterTableParameters( string $table , array $parameters )

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

Параметры

строка $table

Таблица для изменения параметров.

массив $parameters

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

Возвращает

array
Массив инструкций по изменению свойств таблицы.

_buildIndexSubPartисходный код защищенный

_buildIndexSubPart( array $lengths , string $column )

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

Параметры

массив $lengths

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

строка $column

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

Возвращает

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

_dropTableисходный код защищенный

_dropTable( type $table )

Генерирует инструкцию "удаление таблицы" для указанной таблицы

Параметры

тип $table

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

Возвращает

string
Инструкция SQL для удаления таблицы

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

DboSource::_dropTable()

_unsignedисходный код защищенный

_unsigned( string $real )

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

Параметры

строка $real

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

Возвращает

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

alterSchemaисходный код общедоступный

alterSchema( array $compare , string $table null )

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

Параметры

массив $compare

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

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

Имя таблицы.

Возвращает

array
Массив инструкций по изменению.

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

DboSource::alterSchema()

buildIndexисходный код общедоступный

buildIndex( array $indexes , string $table null )

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

Параметры

массив $indexes

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

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

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

Возвращает

array
Массив инструкций SQL для индексов

См. также

DboSource::buildIndex()

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

DboSource::buildIndex()

columnисходный код общедоступный

column( string $real )

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

Параметры

строка $real

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

Возвращает

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

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

DataSource::column()

connectисходный код общедоступный

connect( )

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

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

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

Возвращает

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

Выбрасывает

MissingConnectionException
MissingConnectionException

deleteисходный код общедоступный

delete( Model $model , mixed $conditions null )

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

Параметры

Model $model

Модель для удаления.

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

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

Возвращает

boolean
Успешно

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

DboSource::delete()

describeисходный код общедоступный

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

Выбрасывает

CakeException
CakeException

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

DataSource::describe()

enabledисходный код общедоступный

enabled( )

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

Возвращает

boolean
bool

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

DataSource::enabled()

fetchResultисходный код общедоступный

fetchResult( )

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

Возвращает

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

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

DboSource::fetchResult()

getCharsetNameисходный код общедоступный

getCharsetName( string $name )

Запрос набора символов по сортировке

Параметры

строка $name

Имя сортировки

Возвращает

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

getEncodingисходный код общедоступный

getEncoding( )

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

Возвращает

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

getSchemaNameисходный код общедоступный

getSchemaName( )

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

Возвращает

string
Имя схемы

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

DataSource::getSchemaName()

indexsource public

index( string $model )

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

Параметры

строка $model

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

Возвращает

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

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

DboSource::index()

listDetailedSourcessource public

listDetailedSources( string $name null )

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

Параметры

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

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

Возвращает

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

listSourcessource public

listSources( mixed $data null )

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

Параметры

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

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

Возвращает

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

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

DataSource::listSources()

nestedTransactionSupportedsource public

nestedTransactionSupported( )

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

Возвращает

boolean
bool

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

DboSource::nestedTransactionSupported()

resultSetsource public

resultSet( PDOStatement $results )

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

Параметры

PDOStatement $results

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

setEncodingsource public

setEncoding( string $enc )

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

Параметры

строка $enc

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

Возвращает

boolean
bool

updatesource public

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

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

Параметры

Model $model

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

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

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

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

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

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

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

Возвращает

array
массив

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

DboSource::update()

valuesource public

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

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

Параметры

строка $data

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

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

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

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

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

Возвращает

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

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

DboSource::value()

__constructsource public

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

Конструктор

Параметры

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

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

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

Автоматически ли подключать источник данных.

Вызывает

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

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

DataSource::__construct()

__destructsource public

__destruct( )

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

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

DataSource::__destruct()

_beginNestedsource protected

_beginNested( )

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

Возвращает

boolean
bool

_buildFieldParameterssource protected

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

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

Параметры

строка $columnString

Частично построенная строка столбца

массив $columnData

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

строка $position

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

Возвращает

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

_commitNestedsource protected

_commitNested( )

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

Возвращает

boolean
bool

_constructVirtualFieldssource protected

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

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

Параметры

Model $Model

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

строка $alias

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

массив $fields

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

Возвращает

array
массив

_executesource protected

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

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

Параметры

строка $sql

Оператор SQL

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

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

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

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

Возвращает

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

Вызывает

PDOException
PDOException

_fetchHasAndBelongsToManysource protected

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

Извлечь ассоциации 'hasAndBelongsToMany'.

Параметры

Model $Model

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

строка $query

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

массив $ids

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

строка $association

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

Возвращает

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

_fetchHasManysource protected

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

Извлечь ассоциации 'hasMany'.

Параметры

Model $Model

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

строка $query

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

массив $ids

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

Возвращает

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

_filterResultssource protected

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

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

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

Параметры

массив $resultSet

$resultSet Ссылка на набор результатов для фильтрации.

Model $Model

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

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

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

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

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

_filterResultsInclusivesource protected

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

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

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

Параметры

массив $resultSet

$resultSet Ссылка на набор результатов для фильтрации.

Model $Model

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

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

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

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

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

_getJoinssource protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

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

array
массив

_matchRecordssource protected

_matchRecords( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

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

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

_mergeAssociationsource protected

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

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

Параметры

массив $data

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

массив $merge

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

строка $association

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

строка $type

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

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

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

_mergeConditionssource protected

_mergeConditions( mixed $query , mixed $assoc )

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

Параметры

смешанный $query

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

смешанный $assoc

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

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

array
массив

_mergeHasManysource protected

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

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

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

Параметры

массив $resultSet

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

массив $assocResultSet

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

строка $association

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

Model $Model

Модель, к которой происходит объединение.

_parseKeysource protected

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

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

Параметры

строка $key

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

смешанный $value

Значение(я), которое необходимо вставить в строку.

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

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

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

string
строка

_prepareUpdateFieldssource protected

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

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

Параметры

Model $Model

Модель, для которой необходимо подготовить поля.

массив $fields

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

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

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

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

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

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

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

_quoteFieldssource protected

_quoteFields( string $conditions )

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

Параметры

строка $conditions

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

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

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

_quoteMatchedFieldsource protected

_quoteMatchedField( string $match )

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

Параметры

строка $match

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

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

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

_rollbackNestedsource protected

_rollbackNested( )

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

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

boolean
bool

_scrubQueryDatasource protected

_scrubQueryData( array $data )

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

Параметры

массив $data

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

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

array
массив

_writeQueryCachesource protected

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

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

Параметры

строка $sql

SQL запрос

смешанный $data

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

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

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

beginsource public

begin( )

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

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

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

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

DataSource::begin()

booleansource public

boolean( mixed $data , boolean $quote false )

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

Параметры

смешанное $data

Значение, подлежащее преобразованию

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

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

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

string|boolean
Преобразованное логическое значение

buildAssociationQuerysource public

buildAssociationQuery( Model $Model , array $queryData )

Строит SQL-запрос.

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

Параметры

Model $Model

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

массив $queryData

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

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

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

См. также

DboSource::buildStatement()

buildColumnsource public

buildColumn( array $column )

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

Параметры

массив $column

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

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

string
строка

buildJoinStatementsource public

buildJoinStatement( array $join )

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

Параметры

массив $join

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

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

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

См. также

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

buildStatementsource public

buildStatement( array $query , Model $Model )

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

Параметры

массив $query

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

Model $Model

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

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

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

См. также

DboSource::renderStatement()

buildTableParameterssource public

buildTableParameters( array $parameters , string $table null )

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

Параметры

массив $parameters

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

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

Имя таблицы (необязательно).

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

array
массив

cacheMethodsource public

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

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

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

Параметры

строка $method

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

строка $key

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

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

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

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

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

calculatesource public

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

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

Параметры

Model $Model

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

строка $func

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

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

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

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

string
Функция SQL-вычисления

closesource public

close( )

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

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

DataSource::close()

commitsource public

commit( )

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

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

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

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

DataSource::commit()

conditionKeysToStringsource public

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

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

Параметры

массив $conditions

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

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

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

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

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

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

string
SQL фрагмент

conditionssource 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

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

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

string
SQL фрагмент

createsource public

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

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

Параметры

Model $Model

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

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

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

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

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

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

boolean
Успех

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

DataSource::create()

createSchemasource public

createSchema( CakeSchema $schema , string $tableName null )

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

Параметры

CakeSchema $schema

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

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

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

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

string
строка

defaultConditionssource public

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

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

Параметры

Model $Model

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

string|array|boolean $conditions

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

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

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

Возвращает

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

См. также

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

disconnectsource public

disconnect( )

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

Возвращает

boolean
Всегда true

dropSchemasource public

dropSchema( CakeSchema $schema , string $table null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

string
строка

executesource public

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

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

Опции

• log - Будет ли запрос записан в кэш.

Параметры

string $sql

SQL-запрос

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

Опции для выполнения запроса.

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

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

Возвращает

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

expressionsource public

expression( string $expression )

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

Параметры

string $expression

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

Возвращает

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

fetchAllsource public

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

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

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

Опции

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

Параметры

string $sql

SQL-запрос

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

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

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

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

Возвращает

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

fetchAssociatedsource public

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

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

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

Параметры

Model $Model

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

string $query

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

array $ids

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

Возвращает

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

См. также

DboSource::_fetchHasMany()

fetchRowsource public

fetchRow( string $sql null )

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

Параметры

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

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

Возвращает

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

fetchVirtualFieldsource public

fetchVirtualField( array $result )

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

Параметры

array $result

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

fieldsource public

field( string $name , string $sql )

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

Параметры

string $name

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

string $sql

SQL-запрос.

Возвращает

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

fieldssource public

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

Возвращает

array
массив

flushMethodCachesource public

flushMethodCache( )

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

fullTableNamesource public

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

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

Параметры

Model|string $model

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

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

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

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

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

Возвращает

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

generateAssociationQuerysource 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'.

getConnectionsource public

getConnection( )

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

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

PDO
PDO

getConstraintsource public

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

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

Параметры

string $type

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

Model $Model

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

Model $LinkModel

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

string $association

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

array $assocData

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

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

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

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

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

getLogsource public

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

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

Параметры

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

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

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

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

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

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

getQueryCachesource public

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

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

Параметры

string $sql

SQL-запрос.

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

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

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

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

getVersionsource public

getVersion( )

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

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

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

groupsource public

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

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

Параметры

string|array $fields

Поля GROUP BY.

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

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

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

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

hasAnysource public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

string $sql

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

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

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

hasResultsource public

hasResult( )

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

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

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

identifiersource public

identifier( string $identifier )

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

Параметры

string $identifier

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

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

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

insertMultisource public

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

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

Параметры

string $table

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

array $fields

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

array $values

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

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

boolean
bool

introspectTypesource public

introspectType( string $value )

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

Параметры

string $value

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

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

string
string

isConnectedsource public

isConnected( )

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

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

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

lastAffectedsource public

lastAffected( mixed $source null )

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

Параметры

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

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

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

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

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

DataSource::lastAffected()

lastErrorsource public

lastError( PDOStatement $query null )

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

Параметры

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

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

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

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

lastInsertIdsource public

lastInsertId( mixed $source null )

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

Параметры

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

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

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

mixed
mixed

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

DataSource::lastInsertId()

lastNumRowssource public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

lengthsource public

length( string $real )

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

Параметры

string $real

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

Возвращает

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

limitsource public

limit( integer $limit , integer $offset null )

Возвращает оператор LIMIT в формате, соответствующем конкретной базе данных.

Параметры

integer $limit

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

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

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

Возвращает

string
Оператор SQL LIMIT/OFFSET

logQuerysource public

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

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

Параметры

string $sql

SQL-запрос

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

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

namesource public

name( mixed $data )

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

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

Параметры

mixed $data

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

Возвращает

string
SQL-поле

ordersource public

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

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

Параметры

array|string $keys

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

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

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

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

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

Возвращает

string
Предложение ORDER BY

prepareFieldssource public

prepareFields( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

array $queryData

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

Возвращает

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

querysource public

query( )

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

Возвращает

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

queryAssociationsource 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
при невозможности создания результатов.

rawQuerysource public

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

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

Параметры

string $sql

SQL-запрос

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

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

Возвращает

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

readsource public

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

«Чтение» в CRUD

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

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

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

DataSource::read()

readTableParameterssource public

readTableParameters( string $name )

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

Параметры

string $name

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

Возвращает

array
массив

reconnectsource public

reconnect( array $config array() )

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

Параметры

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

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

Возвращает

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

renderJoinStatementsource public

renderJoinStatement( array $data )

Отображает окончательное SQL-предложение JOIN.

Параметры

array $data

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

Возвращает

string
строка

renderStatementsource public

renderStatement( string $type , array $data )

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

Параметры

string $type

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

array $data

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

Возвращает

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

resetSequencesource public

resetSequence( string $table , string $column )

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

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

Параметры

строка $table

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

строка $column

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

Возвращает

boolean
Успех.

resolveKeysource public

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

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

Параметры

Model $Model

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

строка $key

Поле ключа.

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

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

Возвращает

string
строка

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

DataSource::resolveKey()

rollbacksource public

rollback( )

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

Возвращает

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

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

DataSource::rollback()

showLogsource public

showLog( boolean $sorted false )

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

Параметры

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

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

truncatesource public

truncate( Model|string $table )

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

Параметры

Model|строка $table

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

Возвращает

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

_cacheDescriptionsource protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

строка $object

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

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

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

Возвращает

mixed
смешанный

insertQueryDatasource public

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

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

Параметры

строка $query

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

массив $data

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

строка $association

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

Model $Model

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

массив $stack

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

Возвращает

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

setConfigsource public

setConfig( array $config array() )

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

Параметры

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

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

_mergeVarssource protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethodsource public

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

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

Параметры

строка $method

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

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

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

Возвращает

mixed
Возвращает результат вызова метода

logsource 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
Успех записи в журнал

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

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

Возвращает

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

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

false

array()

200

null

array()

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

null

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

null

'AS '

true

null

false

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

array()

null

null

false

'__'

array()

null

false

true

array()

false