Класс StatementDecorator
Представляет базу данных оператор. Операторы содержат запросы, которые могут быть выполнены несколько раз путем привязки различных значений при каждом вызове. Этот класс также помогает преобразовать значения в их допустимое представление для соответствующих типов.
Этот класс является всего лишь декоратором фактической реализации оператора, например PDOStatement.
- Cake\Database\Statement\StatementDecorator реализует Cake\Database\StatementInterface, Countable, IteratorAggregate использует Cake\Database\TypeConverterTrait
Прямые подклассы
- Cake\Database\Statement\BufferedStatement
- Cake\Database\Statement\CallbackStatement
- Cake\Database\Statement\PDOStatement
Краткое описание свойств
- Ссылка на объект драйвера, связанный с этим оператором.
$_driverprotected -
$_hasExecutedprotectedВыполнялся ли этот оператор ужеboolean -
$_statementprotectedmixedРеализация экземпляра оператора, например PDOStatement или любая другая пользовательская реализация.
Краткое описание методов
- __construct() publicКонструктор
- __get() publicМагический геттер для возвращения $queryString как неизменяемого.
- bind() publicПривязывает набор значений к объекту оператора с соответствующим типом.
- bindValue() public
Присваивает значение позиционному или именованному переменной в подготовленном запросе. Если используются позиционные переменные, необходимо начинать с индекса один, если используются именованные параметры, то просто используйте имя в любом порядке.
- closeCursor() public
Закрывает курсор в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вам не нужно вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
- columnCount() publicВозвращает количество столбцов, которые будут содержать результаты этого оператора.
- count() public
Операторы могут быть переданы в качестве аргумента для count() для возвращения количества затронутых строк из последнего выполнения.
- errorCode() publicВозвращает код ошибки для последней ошибки, которая произошла при выполнении этого оператора.
- errorInfo() public
Возвращает информацию об ошибке для последней ошибки, которая произошла при выполнении этого оператора.
- execute() public
Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы для привязки к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять какое-либо пользовательское преобразование типа, так как это обычно происходит при вызове
bindValue. - fetch() public
Возвращает следующую строку для набора результатов после выполнения этого оператора. Строки могут быть извлечены для содержащей столбцы как имена или позиции. Если строк в наборе результатов больше нет, этот метод вернет false.
- fetchAll() publicВозвращает массив со всеми строками, полученными в результате выполнения этого оператора.
- getInnerStatement() publicВозвращает объект оператора, который был декорирован этим классом.
- getIterator() public
Операторы могут быть итерируемы как массивы, этот метод вернет объект итератора для перебора всех элементов в результате.
- lastInsertId() publicВозвращает последний вставленный первичный ключ, используя этот оператор.
- rowCount() publicВозвращает количество строк, затронутых этим SQL-запросом.
Подробное описание методов
__construct()source public
__construct( Cake\Database\StatementInterface|null $statement null , Cake\Database\Driver|null $driver null )
Конструктор
Параметры
-
Cake\Database\StatementInterface|null$statementoptional null - Реализация оператора, такая как PDOStatement
-
Cake\Database\Driver|null$driveroptional null - Экземпляр драйвера
__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
$typeoptional '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() fetch()source public
fetch( string $type 'num' )
Возвращает следующую строку набора результатов после выполнения этого запроса. Строки можно извлекать, чтобы содержать столбцы как имена или позиции. Если строк в наборе результатов больше нет, этот метод вернет false.
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title'] Параметры
- string
$typeнеобязательно 'num' - 'num' для позиционных столбцов, assoc для именованных столбцов
Возвращает
array|falseМассив результатов, содержащий столбцы и значения, или false, если результатов больше нет
Реализация
Cake\Database\StatementInterface::fetch() fetchAll()source public
fetchAll( string $type 'num' )
Возвращает массив со всеми строками, полученными в результате выполнения этого запроса.
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']] Параметры
- string
$typeнеобязательно 'num' - num для извлечения столбцов как позиционных ключей или assoc для имен столбцов в качестве ключей
Возвращает
arrayСписок всех результатов из базы данных для этого запроса
Реализация
Cake\Database\StatementInterface::fetchAll() 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Подробности свойств
$_statementsource
protected mixed
Реализация объекта запроса, например 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.2/class-Cake.Database.Statement.StatementDecorator.html