Класс 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 -
$_statementprotectedCake\Database\StatementInterface|PDOStatementРеализация объекта оператора, например PDOStatement или любая другая пользовательская реализация.
Краткое описание магических свойств
-
$queryStringpublicstring
Краткое описание методов
- __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|PDOStatement|null $statement null , Cake\Database\Driver|null $driver null )
Конструктор
Параметры
-
Cake\Database\StatementInterface|PDOStatement|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' - имя настроенного класса Type
Реализация
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\StatementInterface|PDOStatementgetIterator()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 Cake\Database\StatementInterface|PDOStatement
Реализация объекта запроса, например PDOStatement или любая другая пользовательская реализация.
Подробности магических свойств
$queryStringsource
public только для чтения string
© 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.StatementDecorator.html