Класс StatementDecorator
Представляет базу данных оператор. Операторы содержат запросы, которые могут быть выполнены несколько раз, связывая разные значения при каждом вызове. Этот класс также помогает преобразовывать значения в их допустимое представление для соответствующих типов.
Этот класс представляет собой декоратор фактической реализации оператора, такого как PDOStatement.
- Cake\Database\Statement\StatementDecorator реализует Cake\Database\StatementInterface, Countable, IteratorAggregate использует Cake\Database\TypeConverterTrait
Прямые подклассы
Унаследованные константы
Резюме свойств
-
$_driverprotectedСсылка на объект драйвера, связанный с этим оператором.Cake\Database\Driver|null -
$_hasExecutedprotectedВыполнялся ли этот оператор ранееboolean -
$_statementprotectedCake\Database\StatementInterface|PDOStatement|nullРеализация экземпляра оператора, например 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Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.
- fetchAssoc() public
Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается false.
- fetchColumn() 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$statementнеобязательно null - Реализация оператора, например PDOStatement
-
Cake\Database\Driver|null$driverнеобязательно 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
$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() для получения количества затронутых строк после последнего выполнения.
Возвращает
целое числоРеализация
Cake\Database\StatementInterface::count() errorCode()source public
errorCode( )
Возвращает код ошибки последней ошибки, произошедшей при выполнении этого выражения.
Возвращает
целое число/строкаРеализация
Cake\Database\StatementInterface::errorCode() errorInfo()source public
errorInfo( )
Возвращает информацию об ошибке для последней ошибки, произошедшей при выполнении этого выражения.
Возвращает
массивРеализация
Cake\Database\StatementInterface::errorInfo() execute()source public
execute( array|null $params = null )
Выполняет выражение, отправляя SQL-запрос в базу данных. Дополнительно может принимать массив или аргументы для привязки к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять преобразование типов, как это обычно происходит при вызове bindValue.
Параметры
- массив|null
$paramsнеобязательно null - список значений для привязки к переменным запроса
Возвращает
булевоистина при успехе, ложь в противном случае
Реализация
Cake\Database\StatementInterface::execute() fetch()source public
fetch( string $type = self::FETCH_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'] Параметры
- строка
$typeнеобязательно self::FETCH_TYPE_NUM - 'num' для позиционных столбцов, 'assoc' для именованных столбцов
Возвращает
массив|ложьМассив результатов, содержащий столбцы и значения, или false, если результатов больше нет
Реализация
Cake\Database\StatementInterface::fetch() fetchAll()source public
fetchAll( string $type = self::FETCH_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']] Параметры
- строка
$typeнеобязательно self::FETCH_TYPE_NUM - 'num' для извлечения столбцов как позиционных ключей или 'assoc' для извлечения столбцов как имен ключей
Возвращает
массивСписок всех результатов из базы данных для этого выражения
Реализация
Cake\Database\StatementInterface::fetchAll() fetchAssoc()source public
fetchAssoc( )
Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результаты не найдены, возвращается false.
Возвращает
массивМассив результатов, содержащий столбцы и значения в виде ассоциативного массива или пустой массив, если результатов нет
fetchColumn()source public
fetchColumn( integer $position )
Возвращает значение результата в указанной позиции.
Параметры
- целое число
$position - Числовая позиция столбца для извлечения в результате
Возвращает
смешанное значение/ложьВозвращает конкретное значение столбца, обозначенного в $position
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
} Возвращает
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 - список или ассоциативный массив типов
Возвращает
массивПодробности свойств
$_driversource
protected Cake\Database\Driver|null
Ссылка на объект драйвера, связанный с этим выражением.
$_statementsource
protected Cake\Database\StatementInterface|PDOStatement|null
Реализация объекта выражения, например PDOStatement или любая другая пользовательская реализация.
Подробности магических свойств
$queryStringsource
public только для чтения строка
© 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.7/class-Cake.Database.Statement.StatementDecorator.html