Spec-Zone.ru › CakePHP 3.3

Класс BufferedStatement

Декоратор оператора, который реализует буферизованные результаты.

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

Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait
Extended by Cake\Database\Statement\BufferedStatement
Пространство имён: Cake\Database\Statement
Расположение: Database/Statement/BufferedStatement.php

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

  • $_allFetched protected
    boolean
    Если true, все строки были получены
  • $_count protected
    integer
    Количество записей
  • $_counter protected
    integer
    Текущий указатель записи
  • $_records protected
    array
    Массив результатов

Унаследованные свойства

  • _driver, _hasExecuted, _statement

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

  • __construct() public
    Конструктор
  • _reset() protected
    Сбросить все свойства
  • execute() public
    Выполнить оператор и вернуть результаты.
  • fetch() public

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

  • fetchAll() public
    Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.
  • rewind() public
    Перемотать свойство _counter
  • rowCount() public
    Возвращает количество строк, затронутых этим SQL-оператором.

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

__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
Экземпляр драйвера

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

Cake\Database\Statement\StatementDecorator::__construct()

_reset()source protected

_reset( )

Сбросить все свойства

execute()source public

execute( array|null $params null )

Выполнить оператор и вернуть результаты.

Параметры

array|null $params необязательно null
список значений, которые нужно привязать к запросу

Возвращает

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

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

Cake\Database\Statement\StatementDecorator::execute()

fetch()source public

fetch( string $type 'num' )

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

Параметры

string $type необязательно 'num'
Тип для извлечения.

Возвращает

array|false

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

Cake\Database\Statement\StatementDecorator::fetch()

fetchAll()source public

fetchAll( string $type 'num' )

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

Параметры

string $type необязательно 'num'
Тип для извлечения.

Возвращает

array

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

Cake\Database\Statement\StatementDecorator::fetchAll()

rewind()source public

rewind( )

Перемотать свойство _counter

rowCount()source public

rowCount( )

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

Возвращает

integer

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

Cake\Database\Statement\StatementDecorator::rowCount()

Методы, унаследованные от Cake\Database\Statement\StatementDecorator

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

errorCode()source public

errorCode( )

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

Возвращает

integer|string

Реализация

Cake\Database\StatementInterface::errorCode()

errorInfo()source public

errorInfo( )

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

Возвращает

array

Реализация

Cake\Database\StatementInterface::errorInfo()

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

Методы, используемые из 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

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

$_allFetchedsource

protected boolean

Если true, все строки были извлечены

true

$_countsource

protected integer

Количество записей

$_countersource

protected integer

Текущий указатель записи

$_recordssource

protected array

Массив результатов

[]

© 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.3/class-Cake.Database.Statement.BufferedStatement.html

Spec-Zone.ru

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