Класс CallbackStatement
Оборачивает оператор в обратный вызов, который позволяет изменять результаты строк при их извлечении.
Используется CakePHP для жадной загрузки данных ассоциаций.
- Cake\Database\Statement\StatementDecorator реализует Cake\Database\StatementInterface, Countable, IteratorAggregate использует Cake\Database\TypeConverterTrait
-
Cake\Database\Statement\CallbackStatement
Краткое описание свойств
-
$_callbackprotectedФункция обратного вызова, которая должна быть применена к результатам.callable
Унаследованные свойства
Краткое описание методов
- __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 'num' )
Извлечение строки из оператора.
Результат будет обработан обратным вызовом, когда он не false.
Параметры
- string
$typeнеобязательно 'num' - Либо 'num', либо 'assoc', чтобы указать желаемый формат результата.
Возвращает
array|falseПереопределяет
Cake\Database\Statement\StatementDecorator::fetch() fetchAll()source public
fetchAll( string $type 'num' )
Извлечение всех строк из оператора.
Каждая строка в результате будет обработана обратным вызовом, когда она не равна `false.
Параметры
- string
$typeнеобязательно 'num' - Либо 'num', либо 'assoc', чтобы указать желаемый формат результата.
Возвращает
arrayПереопределяет
Cake\Database\Statement\StatementDecorator::fetchAll() Методы, унаследованные от Cake\Database\Statement\StatementDecorator
__get()source public
__get( string $property )
Магический геттер для возвращения $queryString в качестве только для чтения.
Параметры
- string
$property - внутреннее свойство для получения
Возвращает
mixedbind()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 - список значений, которые необходимо привязать к запросу
Возвращает
booleantrue при успехе, false в противном случае
Реализация
Cake\Database\StatementInterface::execute() getInnerStatement()source public
getInnerStatement( )
Возвращает объект оператора, который был декорирован этим классом.
Возвращает
Cake\Database\StatementInterfacegetIterator()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Подробное описание свойств
$_callbacksource
protected callable
Функция обратного вызова, которая будет применяться к результатам.
© 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.2/class-Cake.Database.Statement.CallbackStatement.html