Класс Sqlserver

_dropTable()source protected

_dropTable( type $table )

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

Параметры

тип $table

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

Возвращает

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

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

DboSource::_dropTable()

_execute()source protected

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

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

Параметры

строка $sql

SQL-запрос

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

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

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

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

Возвращает

смешанное

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

Вызывает исключение

PDOException

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

DboSource::_execute()

_getPrimaryKey()source protected

_getPrimaryKey( Model|string $model )

Убеждается, что будет возвращён первичный ключ

Параметры

Model|строка $model

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

Возвращает

строка

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( mixed $real )

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

Параметры

смешанный $real

Либо строковое значение типа поля, либо объект результата из Sqlserver::describe()

Возвращает

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

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

DataSource::column()

connect()source public

connect( )

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

Обратите внимание, что атрибут PDO::ATTR_PERSISTENT не поддерживается драйверами SQL Server PHP PDO. В результате вы не можете использовать опцию сохранения подключения при подключении к SQL Server (подробнее см.: https://github.com/Microsoft/msphpsql/issues/65).

Возвращает

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

Выбрасывает

InvalidArgumentException
если в конфигурации базы данных указано недопустимое значение
MissingConnectionException

create()source public

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

Генерирует и выполняет оператор SQL INSERT для заданной модели, полей и значений. Удаляет столбец Identity (первичный ключ) из данных обновления перед возвращением в родительский элемент, если значение пустое.

Параметры

Model $model

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

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

Поля для установки.

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

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

Возвращает

массив

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

DboSource::create()

describe()source public

describe( Model|string $model )

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

Параметры

Model|строка $model

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

Возвращает

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

Выбрасывает

CakeException

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

DataSource::describe()

enabled()source public

enabled( )

Проверка установки/загрузки PDO SQL Server

Возвращает

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

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

DataSource::enabled()

fetchResult()source public

fetchResult( )

Извлечение следующей строки из текущего набора результатов. Удаляет магическую переменную ROW_COUNTER.

Возвращает

смешанный

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

DboSource::fetchResult()

fields()source public

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

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

Параметры

Model $model

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

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

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

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

Поля до этого момента.

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

Нужно ли цитировать идентификаторы.

Возвращает

массив

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

DboSource::fields()

getLockingHint()source public

getLockingHint( mixed $mode )

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

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

Параметры

смешанный $mode

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

Возвращает

строка|null
WITH (UPDLOCK) или null

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

DboSource::getLockingHint()

getSchemaName()source public

getSchemaName( )

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

Возвращает

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

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

DataSource::getSchemaName()

insertMulti()source public

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

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

Параметры

строка $table

Таблица, в которую нужно вставить.

строка $fields

Поля для установки.

массив $values

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

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

DboSource::insertMulti()

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

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

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

Возвращает

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

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

DboSource::lastAffected()

length()source public

length( mixed $length )

Обработка свойств длины, специфичных для SQLServer. SQLServer обрабатывает текстовые типы как nvarchar/varchar с длиной -1.

Параметры

смешанный $length

Длина как строка или объект описания столбца.

Возвращает

смешанный
null|целое число с длиной столбца.

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

DboSource::length()

limit()source public

limit( integer $limit , integer $offset null )

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

Параметры

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

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

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

Смещение для начала результатов

Возвращает

строка
Оператор ограничения/смещения SQL

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

DboSource::limit()

listSources()source public

listSources( mixed $data null )

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

Параметры

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

Имена

Возвращает

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

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

DataSource::listSources()

read()source public

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

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

Параметры

Model $model

Модель для чтения

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

Данные запроса

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

Количество уровней для перехода.

Возвращает

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

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

DboSource::read()

renderStatement()source public

renderStatement( string $type , array $data )

Построение окончательного SQL-запроса

Параметры

строка $type

Тип запроса

массив $data

Данные запроса

Возвращает

строка

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

DboSource::renderStatement()

resultSet()source public

resultSet( PDOStatement $results )

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

Параметры

PDOStatement $results

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

update()source public

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

Генерирует и выполняет оператор SQL UPDATE для заданной модели, полей и значений. Удаляет столбец идентификатора (первичный ключ) из данных обновления перед возвращением родительскому элементу.

Параметры

Model $model

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

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

Поля для установки.

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

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

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

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

Возвращает

array

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

DboSource::update()

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

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

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

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

_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() внутренне.

Параметры

array $resultSet

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

Model $Model

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

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

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

Возвращает

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

_getJoins()source protected

_getJoins( Model $Model )

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

Параметры

Model $Model

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

Возвращает

array

_matchRecords()source protected

_matchRecords( Model $Model , mixed $conditions null )

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

Параметры

Model $Model

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

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

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

Возвращает

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

_mergeAssociation()source protected

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

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

Параметры

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

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

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

Массив информации о 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 )

Кэширует значение в методCaches. Будет учитывать значение 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

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

Возвращает

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

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 )

Генерирует оператор "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 - Выполнять ли логирование запроса в журнал памяти.

Параметры

string $sql

SQL-запрос

array $options optional array()

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

array $params optional 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 optional array()

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

array $options optional 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 optional 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 optional true

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

boolean $schema optional 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

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

string $type

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

string $association

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

array $assocData

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

array $queryData

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

boolean $external

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

Возвращает

mixed

Строка, представляющая запрос. 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 )

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

Параметры

string $type

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

Model $Model

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

Model $LinkModel

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

string $association

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

array $assocData

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

string $association2 optional null

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

Возвращает

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

getLog()source public

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

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

Параметры

boolean $sorted optional false

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

boolean $clear optional true

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

Возвращает

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

getQueryCache()source public

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

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

Параметры

string $sql

SQL-запрос

array $params optional array()

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

Возвращает

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

getVersion()source public

getVersion( )

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

Возвращает

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

group()source public

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

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

Параметры

string|array $fields

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

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

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

Возвращает

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

hasAny()source public

hasAny( Model $Model , string $sql )

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

Параметры

Model $Model

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

string $sql

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

Возвращает

boolean
Истина, если в таблице есть соответствующая запись, иначе ложь

hasResult()source public

hasResult( )

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

Возвращает

boolean
Истина, если результат действителен, иначе ложь

having()source public

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

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

Параметры

mixed $fields

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

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

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

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

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

Возвращает

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

identifier()source public

identifier( string $identifier )

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

Параметры

string $identifier

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

Возвращает

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

index()source public

index( string $model )

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

Параметры

string $model

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

Возвращает

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

introspectType()source public

introspectType( string $value )

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

Параметры

string $value

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

Возвращает

string

isConnected()source public

isConnected( )

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

Возвращает

boolean
Истина, если база данных подключена, иначе ложь

lastError()source public

lastError( PDOStatement $query null )

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

Параметры

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

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

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

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

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

Возвращает

mixed

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

DataSource::lastInsertId()

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

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

name()source public

name( mixed $data )

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

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

Параметры

mixed $data

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

Возвращает

string
SQL-поле

nestedTransactionSupported()source public

nestedTransactionSupported( )

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

Возвращает

boolean

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

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

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

Возвращает

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

readTableParameters()source public

readTableParameters( string $name )

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

Параметры

string $name

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

Возвращает

array

reconnect()source public

reconnect( array $config array() )

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

Параметры

array $config optional array()

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

Возвращает

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

renderJoinStatement()source public

renderJoinStatement( array $data )

Генерирует окончательное SQL-выражение JOIN.

Параметры

array $data

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

Возвращает

string

resetSequence()source public

resetSequence( string $table , string $column )

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

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

Параметры

string $table

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

string $column

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

Возвращает

boolean
Успех.

resolveKey()source public

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

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

Параметры

Model $Model

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

string $key

Поле ключа.

string $assoc optional null

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

Возвращает

string

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

DataSource::resolveKey()

rollback()source public

rollback( )

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

Возвращает

boolean

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

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

DataSource::rollback()

showLog()source public

showLog( boolean $sorted false )

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

Параметры

boolean $sorted optional false

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

truncate()source public

truncate( Model|string $table )

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

Параметры

Model|string $table

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

Возвращает

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

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

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

Параметры

string $object

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

mixed $data optional null

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

Возвращает

mixed

insertQueryData()source public

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

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

Параметры

string $query

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

array $data

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

string $association

Имя модели ассоциации, подлежащей замене.

Model $Model

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

array $stack

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

Возвращает

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

setConfig()source public

setConfig( array $config array() )

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

Параметры

array $config optional array()

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

_mergeVars()source protected

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

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

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

Параметры

array $properties

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

string $class

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

boolean $normalize optional true

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties optional array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

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

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

Возвращает

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

log()source public

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

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

Параметры

string $msg

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

integer $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.

Параметры

string|array $url

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

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

array(
    'host' => 'localhost\SQLEXPRESS',
    'login' => '',
    'password' => '',
    'database' => 'cake',
    'schema' => '',
    'flags' => array()
)

array()

false

array(
    'primary_key' => array('name' => 'IDENTITY (1, 1) NOT NULL'),
    'string' => array('name' => 'nvarchar', 'limit' => '255'),
    'text' => array('name' => 'nvarchar', 'limit' => 'MAX'),
    'integer' => array('name' => 'int', 'formatter' => 'intval'),
    'smallinteger' => array('name' => 'smallint', 'formatter' => 'intval'),
    'tinyinteger' => array('name' => 'tinyint', 'formatter' => 'intval'),
    'biginteger' => array('name' => 'bigint'),
    'numeric' => array('name' => 'decimal', 'formatter' => 'floatval'),
    'decimal' => array('name' => 'decimal', 'formatter' => 'floatval'),
    'float' => array('name' => 'float', 'formatter' => 'floatval'),
    'real' => array('name' => 'float', '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' => 'datetime', 'format' => 'H:i:s', 'formatter' => 'date'),
    'date' => array('name' => 'datetime', 'format' => 'Y-m-d', 'formatter' => 'date'),
    'binary' => array('name' => 'varbinary'),
    'boolean' => array('name' => 'bit')
)

"SQL Server DBO Driver"

"]"

"["