Spec-Zone.ru › CakePHP 3.4

Класс BufferedStatement

Декоратор оператора, реализующий буферизацию результатов.

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

Cake\Database\Statement\StatementDecorator реализует Cake\Database\StatementInterface, Countable, IteratorAggregate использует 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
    Массив результатов

Наследуемые магические свойства

  • queryString

Наследуемые свойства

  • _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()
END_OF_DOCUMENT_MARKER

count()source public

count( )

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

Возвращает

целое число

Реализация

Cake\Database\StatementInterface::count()

errorCode()source public

errorCode( )

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

Возвращает

целое число/строка

Реализация

Cake\Database\StatementInterface::errorCode()

errorInfo()source public

errorInfo( )

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

Возвращает

массив

Реализация

Cake\Database\StatementInterface::errorInfo()

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
}

Возвращает

Итератор

Реализация

IteratorAggregate::getIterator()

lastInsertId()source public

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

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

Параметры

строка|null $table необязательно null
имя таблицы или последовательности, чтобы получить последнее значение вставки
строка|null $column необязательно null
имя столбца, представляющего первичный ключ

Возвращает

строка

Реализация

Cake\Database\StatementInterface::lastInsertId()

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

cast()source public

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

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

Параметры

смешанное $value
Значение для преобразования
Cake\Database\Type|строка $type
Имя типа или экземпляр типа для использования.

Возвращает

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

matchTypes()source public

matchTypes( array $columns , array $types )

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

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

Параметры

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

Возвращает

массив

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

$_allFetchedsource

protected boolean

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

true

$_countsource

protected целое число

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

$_countersource

protected целое число

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

$_recordssource

protected массив

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

[]

© 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.BufferedStatement.html

Spec-Zone.ru

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