Класс Sqlite

_dropTable()source protected

_dropTable( type $table )

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

Параметры

тип $table

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

Возвращает

строка
Оператор SQL для удаления таблицы

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

DboSource::_dropTable()

buildColumn()source public

buildColumn( array $column )

Генерирует строку схемы колонки, соответствующую СУБД

Параметры

массив $column

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

Возвращает

строка

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

DboSource::buildColumn()

buildIndex()source public

buildIndex( array $indexes , string $table null )

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

Параметры

массив $indexes

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

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

Имя таблицы.

Возвращает

строка
Завершенный индекс.

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

DboSource::buildIndex()

column()source public

column( string $real )

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

Параметры

строка $real

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

Возвращает

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

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

DataSource::column()

connect()source public

connect( )

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

Возвращает

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

Имеет исключения

MissingConnectionException

describe()source public

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

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

DataSource::describe()

enabled()source public

enabled( )

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

Возвращает

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

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

DataSource::enabled()

fetchResult()source public

fetchResult( )

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

Возвращает

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

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

DboSource::fetchResult()

getEncoding()source public

getEncoding( )

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

Возвращает

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

getSchemaName()source public

getSchemaName( )

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

Возвращает

string
Имя схемы

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

DataSource::getSchemaName()

hasResult()source public

hasResult( )

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

Возвращает

boolean

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

DboSource::hasResult()

index()source public

index( string $model )

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

Параметры

string $model

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

Возвращает

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

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

DboSource::index()

limit()source public

limit( integer $limit , integer $offset null )

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

Параметры

integer $limit

Ограничение возвращаемых результатов

integer $offset optional null

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

Возвращает

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

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

DboSource::limit()

listSources()source public

listSources( mixed $data null )

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

Параметры

mixed $data optional null

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

Возвращает

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

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

DataSource::listSources()

nestedTransactionSupported()source public

nestedTransactionSupported( )

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

Возвращает

boolean

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

DboSource::nestedTransactionSupported()

renderStatement()source public

renderStatement( string $type , array $data )

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

Параметры

string $type

Тип оператора, который отображается.

array $data

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

Возвращает

string

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

DboSource::renderStatement()

resultSet()source public

resultSet( mixed $results )

Генерация набора результатов

Параметры

mixed $results

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

setEncoding()source public

setEncoding( string $enc )

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

Параметры

string $enc

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

Возвращает

boolean

truncate()source public

truncate( string|Model $table )

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

Параметры

string|Model $table

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

Возвращает

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

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

DboSource::truncate()

update()source public

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

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

Параметры

Model $model

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

array $fields optional array()

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

array $values optional null

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

mixed $conditions optional null

Массив условий для использования.

Возвращает

array

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

DboSource::update()

__construct()source public

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

Конструктор

Параметры

array $config optional null

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

boolean $autoConnect optional true

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

Исключение

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

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

DataSource::__construct()

__destruct()source public

__destruct( )

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

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

DataSource::__destruct()

_beginNested()source protected

_beginNested( )

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

Возвращает

boolean

_buildFieldParameters()source protected

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

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

Параметры

string $columnString

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

array $columnData

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

string $position

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

Возвращает

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

_commitNested()source protected

_commitNested( )

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

Возвращает

boolean

_constructVirtualFields()source protected

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

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

Параметры

Model $Model

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

string $alias

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

array $fields

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

Возвращает

array

_execute()source protected

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

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

Параметры

string $sql

Оператор SQL

array $params optional array()

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

array $prepareOptions optional array()

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

Возвращает

mixed

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

Исключение

PDOException

_fetchHasAndBelongsToMany()source protected

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

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

Параметры

Model $Model

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

строка $query

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

массив $ids

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

строка $association

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

Возвращает

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

_fetchHasMany()source protected

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

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

Параметры

Model $Model

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

строка $query

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

массив $ids

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

Возвращает

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

_filterResults()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

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

Возвращает

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

_filterResultsInclusive()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

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

Возвращает

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

_getJoins()source protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

Возвращает

массив

_matchRecords()source protected

_matchRecords( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

Возвращает

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

_mergeAssociation()source protected

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

Объединение ассоциации в данные

Параметры

массив $data

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

массив $merge

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

строка $association

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

строка $type

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

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

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

_mergeConditions()source protected

_mergeConditions( mixed $query , mixed $assoc )

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

Параметры

смешанный $query

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

смешанный $assoc

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

Возвращает

массив

_mergeHasMany()source protected

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

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

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

Параметры

массив $resultSet

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

массив $assocResultSet

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

строка $association

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

Model $Model

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

_parseKey()source protected

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

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

Параметры

строка $key

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

смешанный $value

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

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

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

Возвращает

строка

_prepareUpdateFields()source protected

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

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

Параметры

Model $Model

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

массив $fields

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

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

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

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

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

Возвращает

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

_quoteFields()source protected

_quoteFields( string $conditions )

Приводит поля Model к кавычкам.

Параметры

строка $conditions

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

Возвращает

строка
или false, если соответствие отсутствует

_quoteMatchedField()source protected

_quoteMatchedField( string $match )

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

Параметры

строка $match

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

Возвращает

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

_rollbackNested()source protected

_rollbackNested( )

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

Возвращает

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

_scrubQueryData()source protected

_scrubQueryData( array $data )

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

Параметры

массив $data

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

Возвращает

массив

_writeQueryCache()source protected

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

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

Параметры

строка $sql

Запрос SQL

смешанный $data

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

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

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

alterSchema()source public

alterSchema( mixed $compare , string $table null )

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

Параметры

смешанный $compare

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

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

Имя таблицы.

Возвращает

boolean

begin()source public

begin( )

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

Возвращает

boolean

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

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

DataSource::begin()

boolean()source public

boolean( mixed $data , boolean $quote false )

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

Параметры

смешанный $data

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

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

Требуется ли преобразование поля в строку.

Возвращает

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

buildAssociationQuery()source public

buildAssociationQuery( Model $Model , array $queryData )

Строит оператор SQL.

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

Параметры

Model $Model

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

массив $queryData

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

Возвращает

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

См. также

DboSource::buildStatement()

buildJoinStatement()source public

buildJoinStatement( array $join )

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

Параметры

массив $join

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

Возвращает

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

См. также

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

buildStatement()source public

buildStatement( array $query , Model $Model )

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

Параметры

массив $query

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

Model $Model

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

Возвращает

строка
Исполнимый оператор SQL.

См. также

DboSource::renderStatement()

buildTableParameters()source public

buildTableParameters( array $parameters , string $table null )

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

Параметры

массив $parameters

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

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

Имя таблицы.

Возвращает

массив

cacheMethod()source public

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

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

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

Параметры

строка $method

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

строка $key

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

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

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

Возвращает

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

cacheMethodFilter()source public

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

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

Некоторые примеры:

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

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

return true;

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

return true;

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

return true;

Параметры

строка $method

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

строка $key

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

смешанный $value

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

Возвращает

булево
Выполнять ли кэширование

cacheMethodHasher()source public

cacheMethodHasher( string $value )

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

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

Параметры

строка $value

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

Возвращает

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

См. также

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

calculate()source public

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

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

Параметры

Model $Model

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

строка $func

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

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

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

Возвращает

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

close()source public

close( )

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

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

DataSource::close()

commit()source public

commit( )

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

Возвращает

boolean

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

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

DataSource::commit()

conditionKeysToString()source public

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

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

Параметры

массив $conditions

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

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

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

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

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

Возвращает

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

conditions()source public

conditions( mixed $conditions , boolean $quoteValues true , boolean $where true , Model $Model null )

Создаёт условие WHERE, анализируя предоставленные данные условий. Если предоставлены массив или строка условий, эти условия будут обработаны и взяты в кавычки. Если предоставлен булево значение, оно будет преобразовано в целое число как условие. Null вернёт 1 = 1.

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

Параметры

mixed $conditions

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

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

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

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

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

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

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

Возвращает

string
SQL фрагмент

create()source public

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

Буква "C" в CRUD

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

boolean
Успех

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

DataSource::create()

createSchema()source public

createSchema( CakeSchema $schema , string $tableName null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

string

defaultConditions()source public

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

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

Параметры

Model $Model

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

string|array|boolean $conditions

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

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

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

Возвращает

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

См. также

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

delete()source public

delete( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

Возвращает

boolean
Успех

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

DataSource::delete()

disconnect()source public

disconnect( )

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

Возвращает

boolean
Всегда true

dropSchema()source public

dropSchema( CakeSchema $schema , string $table null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

string

execute()source public

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

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

Опции

• log - Определяет, нужно ли регистрировать запрос в журнал памяти.

Параметры

string $sql

SQL-заявление

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

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

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

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

Возвращает

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

expression()source public

expression( string $expression )

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

Параметры

string $expression

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

Возвращает

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

fetchAll()source public

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

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

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

Опции

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

Параметры

string $sql

SQL-запрос

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

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

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

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

Возвращает

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

fetchAssociated()source public

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

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

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

Параметры

Model $Model

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

string $query

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

array $ids

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

Возвращает

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

См. также

DboSource::_fetchHasMany()

fetchRow()source public

fetchRow( string $sql null )

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

Параметры

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

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

Возвращает

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

fetchVirtualField()source public

fetchVirtualField( array $result )

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

Параметры

массив $result

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

field()source public

field( string $name , string $sql )

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

Параметры

строка $name

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

строка $sql

SQL-запрос.

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

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

fields()source public

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

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

массив

flushMethodCache()source public

flushMethodCache( )

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

flushQueryCache()source public

flushQueryCache( )

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

fullTableName()source public

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

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

Параметры

Model|строка $model

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

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

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

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

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

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

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

generateAssociationQuery()source public

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

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

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

Параметры

Model $Model

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

Model|null $LinkModel

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

строка $type

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

строка $association

Имя связи.

массив $assocData

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

массив $queryData

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

логическое $external

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

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

смешанное

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

getConnection()source public

getConnection( )

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

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

PDO

getConstraint()source public

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

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

Параметры

строка $type

Тип связи.

Model $Model

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

Model $LinkModel

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

строка $association

Имя связи.

массив $assocData

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

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

Имя связи HABTM.

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

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

getLog()source public

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

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

Параметры

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

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

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

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

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

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

getQueryCache()source public

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

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

Параметры

строка $sql

SQL-запрос

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

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

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

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

getVersion()source public

getVersion( )

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

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

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

group()source public

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

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

Параметры

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

Поля GROUP BY

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

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

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

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

hasAny()source public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

строка $sql

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

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

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

identifier()source public

identifier( string $identifier )

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

Параметры

строка $identifier

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

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

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

insertMulti()source public

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

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

Параметры

строка $table

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

массив $fields

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

массив $values

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

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

логическое

introspectType()source public

introspectType( string $value )

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

Параметры

строка $value

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

Возвращает

строка

isConnected()source public

isConnected( )

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

Возвращает

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

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

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

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

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

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

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

Возвращает

смешанный

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

length()source public

length( string $real )

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

Параметры

строка $real

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

Возвращает

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

logQuery()source public

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

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

Параметры

строка $sql

SQL-запрос

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

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

name()source public

name( mixed $data )

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

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

Параметры

смешанный $data

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

Возвращает

строка
SQL поле

order()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

строка
ORDER BY предложение

prepareFields()source public

prepareFields( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

массив $queryData

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

Возвращает

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

query()source public

query( )

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

Возвращает

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

queryAssociation()source public

queryAssociation( Model $Model , Model $LinkModel , string $type , string $association , array $assocData , array $queryData , boolean $external , array $resultSet , integer $recursive , array $stack )

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

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

• ассоциации 'hasMany' без заданного ограничения: Рекурсивный запрос, фильтрация и слияние выполняются для каждого уровня.

• ассоциации 'hasAndBelongsToMany': Выборка и фильтрация выполняются независимо от установленного (рекурсивного) уровня.

Параметры

Model $Model

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

Model $LinkModel

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

строка $type

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

строка $association

Название ассоциации.

массив $assocData

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

массив $queryData

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

булево $external

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

массив $resultSet

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

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

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

массив $stack

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

Возвращает

смешанный

Выбрасывает

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

rawQuery()source public

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

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

Параметры

строка $sql

SQL-запрос

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

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

Возвращает

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

read()source public

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

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

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

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

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

строка $name

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

Возвращает

массив

reconnect()source public

reconnect( array $config array() )

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

Параметры

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

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

Возвращает

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

renderJoinStatement()source public

renderJoinStatement( array $data )

Рендерит финальное SQL-выражение JOIN

Параметры

массив $data

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

Возвращает

строка

resetSequence()source public

resetSequence( string $table , string $column )

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

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

Параметры

строка $table

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

строка $column

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

Возвращает

boolean
Успех.

resolveKey()source public

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

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

Параметры

Model $Model

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

строка $key

Поле ключа.

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

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

Возвращает

строка

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

DataSource::resolveKey()

rollback()source public

rollback( )

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

Возвращает

boolean

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

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

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

Параметры

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

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

value()source public

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

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

Параметры

строка $data

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

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

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

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

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

Возвращает

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

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

строка $object

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

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

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

Возвращает

смешанный

insertQueryData()source public

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

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

Параметры

строка $query

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

массив $data

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

строка $association

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

Model $Model

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

массив $stack

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

Возвращает

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

setConfig()source public

setConfig( array $config array() )

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

Параметры

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

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

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

log()source public

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

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

Параметры

строка $msg

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

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

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

null|строка|массив $scope необязательно null

Область(и), в которой создаётся сообщение журнала. Для получения дополнительной информации о областях ведения журнала, см. CakeLog::config().

Возвращает

boolean
Успех записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

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

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

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

массив $extra дополнительный массив()

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

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

смешанное

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

toString()source public

toString( )

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

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

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

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

'"'