Spec-Zone.ru › CakePHP 3.1

Класс 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

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

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

fetchsource public

fetch( string $type 'num' )

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

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

Параметры

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

Возвращает

array|false
array|false

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

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

fetchAllsource public

fetchAll( string $type 'num' )

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

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

Параметры

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

Возвращает

array
array

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

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

Наследуемые методы от Cake\Database\Statement\StatementDecorator

__getsource public

__get( string $property )

Магический геттер для возврата $queryString в качестве только для чтения.

Параметры

string $property
внутренняя переменная для получения

Возвращает

mixed
mixed
END_OF_DOCUMENT_MARKER

bindsource public

bind( array $params , array $types )

Связывает набор значений с объектом оператора с соответствующим типом.

Параметры

массив $params
список значений для связывания
массив $types
список типов, используемых, ключи должны соответствовать ключам в $params

Реализация

Cake\Database\StatementInterface::bind()

bindValuesource 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');

Параметры

строка|целое число $column
имя или позиция параметра для связывания
смешанное $value
Значение для привязки к переменной в запросе
строка $type необязательно 'string'
имя класса настроенного типа

Реализация

Cake\Database\StatementInterface::bindValue()

closeCursorsource public

closeCursor( )

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

Реализация

Cake\Database\StatementInterface::closeCursor()

columnCountsource public

columnCount( )

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Возвращает

integer
целое число

Реализация

Cake\Database\StatementInterface::columnCount()

countsource public

count( )

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

Возвращает

integer
целое число

Реализация

Cake\Database\StatementInterface::count()

errorCodesource public

errorCode( )

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

Возвращает

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

Реализация

Cake\Database\StatementInterface::errorCode()

errorInfosource public

errorInfo( )

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

Возвращает

array
массив

Реализация

Cake\Database\StatementInterface::errorInfo()

executesource public

execute( array|null $params null )

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

Параметры

массив|null $params необязательно null
список значений для привязки к запросу

Возвращает

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

Реализация

Cake\Database\StatementInterface::execute()

getInnerStatementsource public

getInnerStatement( )

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

getIteratorsource public

getIterator( )

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

Пример:

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

Возвращает

Iterator
\Iterator

Реализация

IteratorAggregate::getIterator()

lastInsertIdsource public

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

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

Параметры

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

Возвращает

string
строка

Реализация

Cake\Database\StatementInterface::lastInsertId()

rowCountsource public

rowCount( )

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Возвращает

integer
int

Реализация

Cake\Database\StatementInterface::rowCount()

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

castsource public

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

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

Параметры

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

Возвращает

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

matchTypessource public

matchTypes( array $columns , array $types )

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

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

Параметры

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

Возвращает

array
массив

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

$_callbacksource

protected вызываемый объект

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

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

$_driversource

protected Cake\Database\Driver

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

$_hasExecutedsource

protected boolean

Выполнялся ли этот оператор

false

$_statementsource

protected смешанный

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

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Statement.CallbackStatement.html

Spec-Zone.ru

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