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

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

Возвращает

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

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

DboSource::fetchResult()

getEncoding()source public

getEncoding( )

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

Возвращает

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

getLockingHint()source public

getLockingHint( mixed $mode )

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

Источник данных Sqlite не поддерживает блокировку на уровне строк.

Параметры

mixed $mode

Режим блокировки

Возвращает

string|null
Null

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

DboSource::getLockingHint()

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-ограничение/смещение

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

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

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

строка $alias

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

массив $fields

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

Возвращает

массив

_execute()source protected

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

Выполняет заданное SQL-утверждение.

Параметры

строка $sql

SQL-утверждение

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

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

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

Параметры, которые будут использованы в подготовленном утверждении

Возвращает

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

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

Вызывает

PDOException

_fetchHasAndBelongsToMany()source protected

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

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

Параметры

Model $Model

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

строка $query

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

массив $ids

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

строка $association

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

Возвращает

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

_fetchHasMany()source protected

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

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

Параметры

Model $Model

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

строка $query

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

массив $ids

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

Возвращает

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

_filterResults()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

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

Возвращает

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

_filterResultsInclusive()source protected

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

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

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

Параметры

массив $resultSet

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

Model $Model

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

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

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

Возвращает

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

_getJoins()source protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

Возвращает

массив

_matchRecords()source protected

_matchRecords( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

смешанный тип $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.fields.

Параметры

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

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

alterSchema()source public

alterSchema( mixed $compare , string $table null )

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

Параметры

смешанное $compare

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

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

Имя таблицы.

Возвращает

булево

begin()source public

begin( )

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

Возвращает

булево

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

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

DataSource::begin()

boolean()source public

boolean( mixed $data , boolean $quote false )

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

Параметры

смешанное $data

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

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

Признак необходимости преобразования поля в строку.

Возвращает

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

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

Возвращает

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

close()source public

close( )

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

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

DataSource::close()

commit()source public

commit( )

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

Возвращает

булево

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

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

DataSource::commit()

conditionKeysToString()source public

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

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

Параметры

массив $conditions

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

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

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

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

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

Возвращает

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

conditions()source public

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

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

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

Параметры

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

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

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

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

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

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

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

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

Возвращает

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

create()source public

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

Создание в БД (C в CRUD)

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

логическое значение
Успех

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

DataSource::create()

createSchema()source public

createSchema( CakeSchema $schema , string $tableName null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

строка

defaultConditions()source public

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

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

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

См. также

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

delete()source public

delete( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

Возвращает

логическое значение
Успех

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

DataSource::delete()

disconnect()source public

disconnect( )

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

Возвращает

логическое значение
Всегда true

dropSchema()source public

dropSchema( CakeSchema $schema , string $table null )

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

Параметры

CakeSchema $schema

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

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

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

Возвращает

строка

execute()source public

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

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

Параметры

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

Параметры

строка $sql

Оператор SQL

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

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

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

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

Возвращает

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

expression()source public

expression( string $expression )

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

Параметры

строка $expression

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

Возвращает

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

fetchAll()source public

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

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

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

Параметры

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

Параметры

строка $sql

Оператор SQL

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

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

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

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

Возвращает

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

fetchAssociated()source public

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

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

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

Параметры

Model $Model

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

строка $query

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

массив $ids

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

Возвращает

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

См. также

DboSource::_fetchHasMany()

fetchRow()source public

fetchRow( string $sql null )

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

Параметры

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

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

Возвращает

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

fetchVirtualField()source public

fetchVirtualField( array $result )

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

Параметры

массив $result

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

field()source public

field( string $name , string $sql )

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

Параметры

строка $name

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

строка $sql

SQL-запрос.

Возвращает

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

fields()source public

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

Возвращает

массив

flushMethodCache()source public

flushMethodCache( )

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

flushQueryCache()source public

flushQueryCache( )

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

fullTableName()source public

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

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

Параметры

Model|строка $model

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

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

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

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

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

Возвращает

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

generateAssociationQuery()source public

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

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

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

Параметры

Model $Model

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

Model|null $LinkModel

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

строка $type

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

строка $association

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

массив $assocData

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

массив $queryData

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

булево $external

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

Возвращает

смешанный

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

getConnection()source public

getConnection( )

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

Возвращает

PDO

getConstraint()source public

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

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

Параметры

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

having()source public

having( mixed $fields , boolean $quoteValues true , Model $Model null )

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

Параметры

смешанный $fields

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

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

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

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

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

Возвращает

строка|null
Оператор HAVING или null

identifier()source public

identifier( string $identifier )

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

Параметры

строка $identifier

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

Возвращает

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

insertMulti()source public

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

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

Параметры

строка $table

Таблица, в которую происходит вставка.

массив $fields

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

массив $values

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

Возвращает

boolean

introspectType()source public

introspectType( string $value )

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

Параметры

строка $value

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

Возвращает

строка

isConnected()source public

isConnected( )

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

Возвращает

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

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastAffected()

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

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

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

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

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

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

Возвращает

смешанный

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

DataSource::lastInsertId()

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

length()source public

length( string $real )

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

Параметры

строка $real

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

Возвращает

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

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

Буква «R» в CRUD

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

Параметры

Model $Model

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

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

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

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

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

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

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

Возвращает

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

log()source public

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

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

Параметры

строка $msg

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

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

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

null|string|array $scope необязательный null

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

Возвращает

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

requestAction()source public

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

mixed

Булевое значение 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'),
    'smallinteger' => array('name' => 'smallint', 'limit' => null, 'formatter' => 'intval'),
    'tinyinteger' => array('name' => 'tinyint', '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'
        )
    ),
)

'"'