Класс StatementDecorator

__construct()source public

__construct( Cake\Database\StatementInterface|PDOStatement|null $statement = null , Cake\Database\Driver|null $driver = null )

Конструктор

Параметры

Cake\Database\StatementInterface|PDOStatement|null $statement optional null

Реализация оператора, например, PDOStatement

Cake\Database\Driver|null $driver optional null

Экземпляр драйвера

__get()source public

__get( string $property )

Магический метод получения $queryString как только для чтения.

Параметры

string $property

внутреннее свойство для получения

Возвращает

mixed

bind()source public

bind( array $params , array $types )

Связывает набор значений с объектом оператора с соответствующим типом.

Параметры

array $params

список значений для привязки

array $types

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

Реализация

Cake\Database\StatementInterface::bind()

bindValue()source public

bindValue( string|integer $column , mixed $value , string $type = 'string' )

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

Сочетание позиционных и именованных переменных в одном операторе запрещено.

Примеры:

$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');

Параметры

string|integer $column

имя или позиция параметра для привязки

mixed $value

значение для привязки к переменной в запросе

string $type optional 'string'

имя настроенного класса Type

Реализация

Cake\Database\StatementInterface::bindValue()

closeCursor()source public

closeCursor( )

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

Реализация

Cake\Database\StatementInterface::closeCursor()

columnCount()source public

columnCount( )

Возвращает количество столбцов, которые будут содержать результаты этого оператора.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Возвращает

integer

Реализация

Cake\Database\StatementInterface::columnCount()

count()source public

count( )

Операторы могут передаваться в качестве аргумента для count() для возвращения количества затронутых строк от последнего выполнения.

Возвращает

integer

Реализация

Cake\Database\StatementInterface::count()

errorCode()source public

errorCode( )

Возвращает код ошибки для последней ошибки, возникшей при выполнении этого оператора.

Возвращает

integer|string

Реализация

Cake\Database\StatementInterface::errorCode()

errorInfo()source public

errorInfo( )

Возвращает информацию об ошибке для последней ошибки, возникшей при выполнении этого оператора.

Возвращает

array

Реализация

Cake\Database\StatementInterface::errorInfo()

execute()source public

execute( array|null $params = null )

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

Параметры

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

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

Возвращает

boolean
true при успехе, false в противном случае

Реализация

Cake\Database\StatementInterface::execute()

fetch()source public

fetch( string $type = self::FETCH_TYPE_NUM )

Возвращает следующую строку для набора результатов после выполнения этого оператора. Строки могут извлекаться, содержащие столбцы в виде имён или позиций. Если в наборе результатов больше нет строк, этот метод вернет false.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Параметры

string $type необязательно self::FETCH_TYPE_NUM

'num' для позиционных столбцов, assoc для именованных столбцов

Возвращает

array|false

Массив результатов, содержащий столбцы и значения, или false, если результатов больше нет

Реализация

Cake\Database\StatementInterface::fetch()

fetchAll()source public

fetchAll( string $type = self::FETCH_TYPE_NUM )

Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Параметры

string $type необязательно self::FETCH_TYPE_NUM

num для извлечения столбцов в качестве позиционных ключей или assoc для названий столбцов в качестве ключей

Возвращает

array
Список всех результатов из базы данных для этого оператора

Реализация

Cake\Database\StatementInterface::fetchAll()

fetchAssoc()source public

fetchAssoc( )

Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов не найдено, возвращается false.

Возвращает

array|false
Массив результатов, содержащий столбцы и значения в виде ассоциативного массива или false, если результатов нет

fetchColumn()source public

fetchColumn( integer $position )

Возвращает значение результата в позиции.

Параметры

integer $position

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

Возвращает

mixed|false
Возвращает конкретное значение столбца, указанного в $position

getInnerStatement()source public

getInnerStatement( )

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

Возвращает

Cake\Database\StatementInterface|PDOStatement

getIterator()source public

getIterator( )

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Возвращает

Cake\Database\StatementInterface|PDOStatement

Реализация

IteratorAggregate::getIterator()

lastInsertId()source public

lastInsertId( string|null $table = null , string|null $column = null )

Возвращает последний вставленный первичный ключ с помощью этого оператора.

Параметры

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

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

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

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

Возвращает

string|integer

Реализация

Cake\Database\StatementInterface::lastInsertId()

rowCount()source public

rowCount( )

Возвращает количество строк, затронутых этим SQL-оператором.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Возвращает

integer

Реализация

Cake\Database\StatementInterface::rowCount()

cast()source public

cast( mixed $value , Cake\Database\Type|string $type )

Преобразует данное значение в подходящее значение базы данных на основе типа и возвращает соответствующий внутренний тип оператора

Параметры

mixed $value

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

Cake\Database\Type|string $type

Название типа или экземпляр типа для использования.

Возвращает

array
Список, содержащий преобразованное значение и внутренний тип

matchTypes()source public

matchTypes( array $columns , array $types )

Сопоставляет столбцы с соответствующими типами

И $columns, и $types должны быть либо числовыми, либо строковыми ключами одновременно.

Параметры

array $columns

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

array $types

список или ассоциативный массив типов

Возвращает

array

false