Spec-Zone.ru › CakePHP 3.6

Класс CallbackStatement

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

Используется CakePHP для жадного загрузки данных ассоциации.

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

Наследуемые константы

  • FETCH_TYPE_ASSOC, FETCH_TYPE_NUM, FETCH_TYPE_OBJ

Резюме свойств

  • $_callback protected
    callable
    Функция обратного вызова, которая будет применяться к результатам.

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

  • queryString

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

  • _driver, _hasExecuted, _statement

Резюме методов

  • __construct() public
    Конструктор
  • fetch() public
    Извлечение строки из оператора.
  • fetchAll() public
    Извлечение всех строк из оператора.

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

__construct()source public

__construct( Cake\Database\StatementInterface $statement , Cake\Database\Driver $driver , callable $callback )

Конструктор

Параметры

Cake\Database\StatementInterface $statement
Оператор для декорирования.
Cake\Database\Driver $driver
Экземпляр драйвера, используемый оператором.
callable $callback
Обратный вызов для применения к результатам перед их возвратом.

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

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

fetch()source public

fetch( string $type = parent::FETCH_TYPE_NUM )

Извлечение строки из оператора.

Результат будет обработан обратным вызовом, когда он не false.

Параметры

string $type необязательно parent::FETCH_TYPE_NUM
Либо 'num', либо 'assoc', чтобы указать требуемый формат результата.

Возвращает

array|false

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

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

fetchAll()source public

fetchAll( string $type = parent::FETCH_TYPE_NUM )

Извлечение всех строк из оператора.

Каждая строка в результате будет обработана обратным вызовом, когда она не равна `false.

Параметры

string $type необязательно parent::FETCH_TYPE_NUM
Либо 'num', либо 'assoc', чтобы указать требуемый формат результата.

Возвращает

array

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

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

Методы, унаследованные от 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()

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

fetchAssoc()source public

fetchAssoc( )

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

Возвращает

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

fetchColumn()source public

fetchColumn( integer $position )

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

Параметры

целое число $position
Числовая позиция столбца, который необходимо извлечь из результата

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

смешанный тип/ложь
Возвращает конкретное значение столбца, указанного в $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 )

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

Параметры

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

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

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

Реализация

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

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

целое число

Реализация

Cake\Database\StatementInterface::rowCount()

Методы, используемые из 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
список или ассоциативный массив типов

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

массив

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

$_callbacksource

protected вызываемая функция

Функция обратного вызова, которая должна быть применена к результатам.

© 2005–present 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.6/class-Cake.Database.Statement.CallbackStatement.html

Spec-Zone.ru

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