Класс Sqlite

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

_dropTable( type $table )

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

Параметры

тип $table

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

Возвращает

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

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

DboSource::_dropTable()

buildColumnисходный код открытый

buildColumn( array $column )

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

Параметры

массив $column

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

Возвращает

string
строка

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

DboSource::buildColumn()

buildIndexисходный код открытый

buildIndex( array $indexes , string $table null )

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

Параметры

массив $indexes

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

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

Имя таблицы.

Возвращает

string
Полный индекс.

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

DboSource::buildIndex()

columnисходный код открытый

column( string $real )

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

Параметры

строка $real

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

Возвращает

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

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

DataSource::column()

connectисходный код открытый

connect( )

Подключается к базе данных, используя config['database'] в качестве имени файла.

Возвращает

boolean
bool

Выбрасывает

MissingConnectionException
MissingConnectionException

describeисходный код открытый

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

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

DataSource::describe()

enabledисходный код открытый

enabled( )

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

Возвращает

boolean
bool

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

DataSource::enabled()

fetchResultисходный код открытый

fetchResult( )

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

Возвращает

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

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

DboSource::fetchResult()

getEncodingисходный код открытый

getEncoding( )

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

Возвращает

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

getSchemaNameисходный код открытый

getSchemaName( )

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

Возвращает

string
Имя схемы

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

DataSource::getSchemaName()

hasResultисходный код открытый

hasResult( )

PDO работает с объектами, а не ресурсами, поэтому переопределите соответствующим образом.

Возвращает

boolean
bool

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

DboSource::hasResult()

indexисходный код открытый

index( string $model )

Переопределяет DboSource::index для обработки интроспекции индексов SQLite Возвращает массив индексов в заданном имени таблицы.

Параметры

строка $model

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

Возвращает

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

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

DboSource::index()

limitисходный код открытый

limit( integer $limit , integer $offset null )

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

Параметры

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

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

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

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

Возвращает

string
SQL-оператор limit/offset

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

DboSource::limit()

listSourcesисходный код открытый

listSources( mixed $data null )

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

Параметры

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

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

Возвращает

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

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

DataSource::listSources()

nestedTransactionSupportedисходный код открытый

nestedTransactionSupported( )

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

Возвращает

boolean
bool

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

DboSource::nestedTransactionSupported()

renderStatementисходный код открытый

renderStatement( string $type , array $data )

Переопределяет DboSource::renderStatement для обработки генерации схемы с индексами в стиле SQLite

Параметры

строка $type

Тип выполняемого запроса.

массив $data

Данные для преобразования в SQL.

Возвращает

string
строка

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

DboSource::renderStatement()

resultSetисходный код открытый

resultSet( mixed $results )

Генерирует ResultSet

Параметры

смешанный $results

Результаты для изменения.

setEncodingисходный код открытый

setEncoding( string $enc )

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

Параметры

строка $enc

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

Возвращает

boolean
bool

truncatesource public

truncate( string|Model $table )

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

Параметры

строка|Model $table

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

Возвращает

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

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

DboSource::truncate()

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

__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 в случае ошибки запроса, возвращающего нулевые строки, например, оператор 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
Массив результатов, отфильтрованных через $Model->afterFind.

_filterResultsInclusivesource protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

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

Возвращает

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

_getJoinssource protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

Возвращает

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

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

alterSchemasource public

alterSchema( mixed $compare , string $table null )

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

Параметры

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

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

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

Имя таблицы.

Возвращает

boolean
bool

beginsource public

begin( )

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

Возвращает

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

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

DataSource::begin()

booleansource public

boolean( mixed $data , boolean $quote false )

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

Параметры

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

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

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

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

Возвращает

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

buildAssociationQuerysource public

buildAssociationQuery( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

массив $queryData

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

Возвращает

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

См.

DboSource::buildStatement()

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

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

булево $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

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

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

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

булево $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

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

строка|массив|булево $conditions

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

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

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

Возвращает

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

См. также

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

deletesource public

delete( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

Возвращает

boolean
Успех

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

DataSource::delete()

disconnectsource public

disconnect( )

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

Возвращает

boolean
Всегда true

dropSchemasource public

dropSchema( CakeSchema $schema , string $table null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

string
строка

executesource public

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

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

Параметры

• log - Записывать ли запрос в кэш-лог.

Параметры

строка $sql

SQL-заявление

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

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

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

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

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

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

expressionsource public

expression( string $expression )

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

Параметры

строка $expression

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

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

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

fetchAllsource public

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

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

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

Параметры

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

Параметры

строка $sql

SQL-запрос

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

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

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

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

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

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

fetchAssociatedsource public

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

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

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

Параметры

Model $Model

Объект модели-родителя.

строка $query

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

массив $ids

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

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

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

См. также

DboSource::_fetchHasMany()

fetchRowsource public

fetchRow( string $sql null )

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

Параметры

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

SQL-код для выполнения.

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

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

fetchVirtualFieldsource public

fetchVirtualField( array $result )

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

Параметры

массив $result

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

fieldsource public

field( string $name , string $sql )

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

Параметры

строка $name

Имя поля для получения.

строка $sql

SQL-запрос.

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

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

fieldssource public

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

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

array
массив

flushMethodCachesource public

flushMethodCache( )

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

fullTableNamesource public

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

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

Параметры

Model|строка $model

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

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

Нужно ли экранировать имя таблицы.

булево $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

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

строка $type

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

строка $association

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

массив $assocData

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

массив $queryData

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

булево $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 )

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

Параметры

строка $type

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

Model $Model

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

Model $LinkModel

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

строка $association

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

массив $assocData

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

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

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 для неизвестной длины.

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

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

массив $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

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

строка $type

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

строка $association

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

массив $assocData

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

массив $queryData

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

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

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

массив $resultSet

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

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

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

массив $stack

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

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

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

Исключения

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

rawQuerysource public

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

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

Параметры

строка $sql

SQL-запрос

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

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

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

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

readsource public

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

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

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

DataSource::read()

readTableParameterssource public

readTableParameters( string $name )

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

Параметры

строка $name

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

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

array
массив

reconnectsource public

reconnect( array $config array() )

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

Параметры

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

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

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

boolean
True при успехе, false при ошибке

renderJoinStatementsource public

renderJoinStatement( array $data )

Генерирует окончательный SQL-запрос JOIN

Параметры

массив $data

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

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

string
строка

resetSequencesource public

resetSequence( string $table , string $column )

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

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

Параметры

строка $table

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

строка $column

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

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

boolean
Успех.

resolveKeysource public

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

Возвращает ключ в формате "ИмяМодели.ИмяПоля" (например, 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 )

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

Параметры

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

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

valuesource public

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

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

Параметры

строка $data

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

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

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

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

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

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

string
Заключённые в кавычки и экранированные данные

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

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

Параметры

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

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

_mergeVarssource protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_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 необязательно array()

Список параметров для использования при вызове $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 необязательно array()

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

array(
    'persistent' => false,
    'database' => null,
    'flags' => array()
)

array(
    'primary_key' => array('name' => 'integer primary key autoincrement'),
    'string' => array('name' => 'varchar', 'limit' => '255'),
    'text' => array('name' => 'text'),
    'integer' => array('name' => 'integer', 'limit' => null, 'formatter' => 'intval'),
    'biginteger' => array('name' => 'bigint', 'limit' => 20),
    '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' => 'boolean')
)

"SQLite DBO Driver"

'"'

array(
    'collate' => array(
        'value' => 'COLLATE',
        'quote' => false,
        'join' => ' ',
        'column' => 'Collate',
        'position' => 'afterDefault',
        'options' => array(
            'BINARY', 'NOCASE', 'RTRIM'
        )
    ),
)

'"'

null

false

array()

200

null

array()

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

null

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

null

'AS '

true

null

false

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

array()

null

array()

null

false

'__'

array()

null

false

true

array()

false