Spec-Zone.ru › CakePHP 3.4

Класс StatementDecorator

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

Этот класс представляет собой декоратор фактической реализации оператора, например PDOStatement.

Cake\Database\Statement\StatementDecorator реализует Cake\Database\StatementInterface, Countable, IteratorAggregate использует Cake\Database\TypeConverterTrait

Прямые подклассы

  • Cake\Database\Statement\BufferedStatement
  • Cake\Database\Statement\CallbackStatement
  • Cake\Database\Statement\PDOStatement
Пространство имен: Cake\Database\Statement
Расположение: Database/Statement/StatementDecorator.php

Краткое описание свойств

  • $_driver protected
    Cake\Database\Driver
    Ссылка на объект драйвера, связанный с этим оператором.
  • $_hasExecuted protected
    boolean
    Выполнялся ли этот оператор ранее
  • $_statement protected
    Cake\Database\StatementInterface|PDOStatement

    Реализация объекта оператора, например PDOStatement или любая другая пользовательская реализация.

Краткое описание магических свойств

  • $queryString public
    string

Краткое описание методов

  • __construct() public
    Конструктор
  • __get() public
    Магический геттер для возвращения $queryString в режиме только для чтения.
  • bind() public
    Связывает набор значений с объектом оператора с соответствующим типом.
  • bindValue() public

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

  • closeCursor() public

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

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

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

  • errorCode() public
    Возвращает код ошибки последней ошибки, возникшей при выполнении этого оператора.
  • errorInfo() public

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

  • execute() public

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

  • fetch() public

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

  • fetchAll() public
    Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.
  • getInnerStatement() public
    Возвращает объект оператора, который был декорирован этим классом.
  • getIterator() public

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

  • lastInsertId() public
    Возвращает последний вставленный первичный ключ, используемый этим оператором.
  • rowCount() public
    Возвращает количество строк, затронутых этим SQL-оператором.

Подробное описание методов

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

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|PDOStatement

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

Методы, используемые из Cake\Database\TypeConverterTrait

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

Подробности свойств

$_driversource

protected Cake\Database\Driver

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

$_hasExecutedsource

protected boolean

Выполнен ли этот запрос уже

false

$_statementsource

protected Cake\Database\StatementInterface|PDOStatement

Реализация объекта запроса, например PDOStatement или любая другая пользовательская реализация.

Подробности магических свойств

$queryStringsource

public только для чтения string

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Database.Statement.StatementDecorator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API