Класс StatementDecorator

__construct()source public

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

Конструктор

Параметры

Cake\Database\StatementInterface|null $statement необязательный null

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

Cake\Database\Driver|null $driver необязательный 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 необязательный 'string'

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

Реализация

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 '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 необязательно 'num'

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

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

array|false

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

Реализация

Cake\Database\StatementInterface::fetch()

fetchAll()source public

fetchAll( string $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 необязательно 'num'

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

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

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

Реализация

Cake\Database\StatementInterface::fetchAll()

getInnerStatement()source public

getInnerStatement( )

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

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

Cake\Database\StatementInterface

getIterator()source public

getIterator( )

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

Пример:

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

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

Iterator

Реализация

IteratorAggregate::getIterator()

lastInsertId()source public

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

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

Параметры

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

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

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

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

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

string

Реализация

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