Класс Postgres

_alterIndexes()source protected

_alterIndexes( string $table , array $indexes )

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

Параметры

строка $table

Таблица, для которой изменяются индексы

массив $indexes

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

Возвращает

массив
Операторы изменения индексов

_quoteFunctionField()source protected

_quoteFunctionField( string $match )

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

Параметры

строка $match

Совпавший текст

Возвращает

строка
Цитированная строка

alterSchema()source public

alterSchema( array $compare , string $table null )

Изменить схему таблицы.

Параметры

массив $compare

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

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

имя таблицы

Возвращает

массив

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

DboSource::alterSchema()

boolean()source public

boolean( mixed $data , boolean $quote false )

Преобразует значения логических типов PHP в значения логических типов PostgreSQL

Параметры

смешанное $data

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

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

true для цитирования булевого значения для использования в запросе, false для возврата значения булевого типа

Возвращает

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

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

DboSource::boolean()

buildColumn()source public

buildColumn( array $column )

Сгенерировать строку схемы столбца Postgres

Параметры

массив $column

Массив, структурированный как следующий: array('name'=>'значение', 'type'=>'значение'[, 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( )

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

Возвращает

логическое значение
Истина, если подключение успешно.

Выбрасывает

MissingConnectionException

describe()source public

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

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

DataSource::describe()

enabled()source public

enabled( )

Проверить, включен ли/загружен ли PostgreSQL

Возвращает

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

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

DataSource::enabled()

fetchResult()source public

fetchResult( )

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

Возвращает

массив

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

DboSource::fetchResult()

fields()source public

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

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

Параметры

Model $model

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

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

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

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

Список полей для получения.

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

Признак цитирования идентификаторов.

Возвращает

массив

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

DboSource::fields()

getEncoding()source public

getEncoding( )

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

Возвращает

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

getSchemaName()source public

getSchemaName( )

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

Возвращает

строка
Имя схемы

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

DataSource::getSchemaName()

getSequence()source public

getSequence( string|Model $table , string $field 'id' )

Получить связанную последовательность для заданной таблицы/поля

Параметры

строка|Model $table

Полное имя таблицы (с префиксом) в виде строки или объект модели

строка $field необязательно 'id'

Имя поля ID базы данных. По умолчанию "id"

Возвращает

строка
Имя связанной последовательности из карты последовательностей, по умолчанию "{$table}_{$field}_seq"

index()source public

index( string $model )

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

Параметры

строка $model

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

Возвращает

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

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

DboSource::index()

lastInsertId()source public

lastInsertId( string $source null , string $field 'id' )

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

Параметры

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

Имя таблицы базы данных

строка $field необязательно 'id'

Имя поля ID базы данных. По умолчанию "id"

Возвращает

целое число

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

DboSource::lastInsertId()

length()source public

length( string $real )

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

Параметры

строка $real

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

Возвращает

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

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

DboSource::length()

limit()source public

limit( integer $limit , integer $offset null )

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

Параметры

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

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

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

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

Возвращает

строка
SQL оператор LIMIT/OFFSET

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

DboSource::limit()

listSources()source public

listSources( mixed $data null )

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

Параметры

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

Источники для вывода.

Возвращает

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

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

DataSource::listSources()

name()source public

name( string $data )

Подготавливает имена полей для цитирования родительским классом

Параметры

строка $data

Имя для форматирования.

Возвращает

строка
SQL поле

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

DboSource::name()

nestedTransactionSupported()source public

nestedTransactionSupported( )

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

Возвращает

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

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

DboSource::nestedTransactionSupported()

renderStatement()source public

renderStatement( string $type , array $data )

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

Параметры

строка $type

Тип запроса.

массив $data

Массив данных для рендеринга.

Возвращает

строка

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

DboSource::renderStatement()

resetSequence()source public

resetSequence( string $table , string $column )

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

Параметры

string $table

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

string $column

Столбец, используемый для сброса значения последовательности; имя последовательности будет получено с помощью Postgres::getSequence();

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

boolean
успех.

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

DboSource::resetSequence()

resultSet()source public

resultSet( array $results )

Метод resultSet

Параметры

array $results

$results Результаты

setEncoding()source public

setEncoding( mixed $enc )

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

Параметры

mixed $enc

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

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

boolean
Истина при успехе, ложь при ошибке

truncate()source public

truncate( string|Model $table , boolean $reset false )

Удаляет все записи в таблице и удаляет все связанные последовательности автоинкремента

Параметры

string|Model $table

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

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

true для сброса последовательности, false для сохранения текущего состояния. Если 1, последовательности не изменяются

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

boolean
SQL-выражение TRUNCATE TABLE, ложь, если не применимо.

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

DboSource::truncate()

value()source public

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

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

Параметры

string $data

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

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

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

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

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

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

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

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

DboSource::value()

__construct()source public

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

Конструктор

Параметры

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

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

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

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

Исключения

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

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

DataSource::__construct()

__destruct()source public

__destruct( )

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

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

DataSource::__destruct()

_beginNested()source protected

_beginNested( )

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

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

boolean

_buildFieldParameters()source protected

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

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

Параметры

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

_dropTable()source protected

_dropTable( type $table )

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

Параметры

type $table

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

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

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

_execute()source protected

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

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

Параметры

string $sql

SQL-запрос

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

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

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

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

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

mixed

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

Исключения

PDOException

_fetchHasAndBelongsToMany()source protected

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

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

Параметры

Model $Model

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

string $query

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

array $ids

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

string $association

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

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

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

_fetchHasMany()source protected

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

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

Параметры

Model $Model

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

string $query

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

array $ids

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

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

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

_filterResults()source protected

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

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

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

Параметры

array $resultSet

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

Model $Model

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

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

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

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

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 )

Приводит поля модели к нужному виду.

Параметры

строка $conditions

Условие для приведения к нужному виду.

Возвращает

строка
или ложь, если совпадений нет.

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

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

begin()source public

begin( )

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

Возвращает

логическое

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

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

DataSource::begin()

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

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

Возвращает

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

См. также

DboSource::renderStatement()

buildTableParameters()source public

buildTableParameters( array $parameters , string $table null )

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

Параметры

массив $parameters

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

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

Имя таблицы.

Возвращает

массив

cacheMethod()source public

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

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

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

Параметры

строка $method

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

строка $key

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

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

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

Возвращает

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

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

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

Возвращает

булево

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

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

Возвращает

строка
Фрагмент 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

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

Возвращает

строка
Фрагмент 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

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

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, либо boolean для управления кэшированием запросов.

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, чтобы поместить виртуальные поля в запись модели, куда они относятся

Параметры

array $result

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

field()source public

field( string $name , string $sql )

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

Параметры

string $name

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

string $sql

SQL-запрос.

Возвращает

mixed
Значение прочитанного поля или 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|string $model

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

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

Требуется ли заключение имени таблицы в кавычки.

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

Требуется ли включение имени схемы.

Возвращает

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

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`.

getLockingHint()source public

getLockingHint( mixed $mode )

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

В настоящее время этот метод возвращает только FOR UPDATE, когда режим установлен в true.

Параметры

смешанный $mode

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

Возвращает

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

getLog()source public

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

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

Параметры

булево $sorted опционально false

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

булево $clear опционально true

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

Возвращает

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

getQueryCache()source public

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

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

Параметры

строка $sql

SQL-запрос

массив $params опционально array()

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

Возвращает

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

getVersion()source public

getVersion( )

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

Возвращает

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

group()source public

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

Создание SQL-описания GROUP BY.

Параметры

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

Поля для группировки.

Model $Model опционально null

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

Возвращает

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

hasAny()source public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

строка $sql

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

Возвращает

булево
True, если в таблице есть совпадения, иначе false

hasResult()source public

hasResult( )

Проверка валидности результата.

Возвращает

булево
True, если результат валидный, иначе false

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`.

Возвращает

булево

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

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

Возвращает

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

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DataSource::lastNumRows()

logQuery()source public

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

Залогировать заданный SQL запрос.

Параметры

string $sql

SQL-запрос

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

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

order()source public

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

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

Параметры

array|string $keys

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

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

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

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

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

Возвращает

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

prepareFields()source public

prepareFields( Model $Model , array $queryData )

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

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

Параметры

Model $Model

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

array $queryData

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

Возвращает

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

query()source public

query( )

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

Возвращает

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

queryAssociation()source public

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

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

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

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

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

Параметры

Model $Model

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

Model $LinkModel

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

string $type

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

string $association

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

array $assocData

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

array $queryData

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

boolean $external

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

array $resultSet

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

integer $recursive

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

array $stack

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

Возвращает

mixed

Выбрасывает

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

rawQuery()source public

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

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

Параметры

string $sql

SQL-запрос

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

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

Возвращает

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

read()source public

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

«Чтение» в CRUD

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

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

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

DataSource::read()

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

string $name

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

Возвращает

array

reconnect()source public

reconnect( array $config array() )

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

Параметры

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

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

Возвращает

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

renderJoinStatement()source public

renderJoinStatement( array $data )

Выводит окончательное SQL-предложение JOIN

Параметры

array $data

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

Возвращает

string

resolveKey()source public

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

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

Параметры

Model $Model

Модель для получения ключа.

string $key

Ключевое поле.

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

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

Возвращает

string

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

DataSource::resolveKey()

rollback()source public

rollback( )

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

Возвращает

boolean

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

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

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

Параметры

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

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

update()source public

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

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

Параметры

Model $Model

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

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

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

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

Значения полей.

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

Условие для обновления. Если не пусто, $values не будут заключены в кавычки.

Возвращает

boolean
Успех

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

DataSource::update()

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

Кэшировать описание источника данных

Параметры

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

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

Параметры

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

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_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() для получения дополнительной информации о областях ведения журнала.

Возвращает

логическое
Успешность записи в лог

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' => true,
    'host' => 'localhost',
    'login' => 'root',
    'password' => '',
    'database' => 'cake',
    'schema' => 'public',
    'port' => 5432,
    'encoding' => '',
    'sslmode' => 'allow',
    'flags' => array()
)

array()

array('like', 'ilike', 'or', 'not', 'in', 'between', '~', '~\*', '\!~', '\!~\*', 'similar to')

array(
    'primary_key' => array('name' => 'serial NOT NULL'),
    'string' => array('name' => 'varchar', 'limit' => '255'),
    'text' => array('name' => 'text'),
    'integer' => array('name' => 'integer', 'formatter' => 'intval'),
    'smallinteger' => array('name' => 'smallint', 'formatter' => 'intval'),
    'tinyinteger' => array('name' => 'smallint', 'formatter' => 'intval'),
    'biginteger' => array('name' => 'bigint', 'limit' => '20'),
    'float' => array('name' => 'float', 'formatter' => 'floatval'),
    'decimal' => array('name' => 'decimal', 'formatter' => 'floatval'),
    'datetime' => array('name' => 'timestamp', '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' => 'bytea'),
    'boolean' => array('name' => 'boolean'),
    'number' => array('name' => 'numeric'),
    'inet' => array('name' => 'inet'),
    'uuid' => array('name' => 'uuid')
)

"PostgreSQL DBO Driver"

'"'

'"'