Spec-Zone.ru › CakePHP 3.5

Класс PDOStatement

Декоратор для класса \PDOStatement, в основном используемый для преобразования удобочитаемых режимов извлечения в константы PDO.

Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait
Extended by Cake\Database\Statement\PDOStatement
Пространство имён: Cake\Database\Statement
Расположение: Database/Statement/PDOStatement.php

Наследуемые магические свойства

  • queryString

Наследуемые свойства

  • _driver, _hasExecuted, _statement

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

  • __construct() public
    Конструктор
  • bindValue() public

    Присваивает значение позиционному или именованному параметру в подготовленном запросе. При использовании позиционных параметров необходимо начинать с индекса один, при использовании именованных параметров используйте имя в любом порядке.

  • fetch() public

    Возвращает следующую строку набора результатов после выполнения этого запроса. Строки могут быть извлечены, чтобы содержать столбцы как имена или позиции. Если в наборе результатов нет строк, этот метод вернёт false

  • fetchAll() public
    Возвращает массив со всеми строками, полученными в результате выполнения этого запроса

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

__construct()source public

__construct( Cake\Database\Statement\PDOStatement $statement null , Cake\Database\Driver|null $driver null )

Конструктор

Параметры

Cake\Database\Statement\PDOStatement $statement необязательно null
Исходный запрос, который необходимо декорировать.
Cake\Database\Driver|null $driver необязательно null
Экземпляр драйвера.

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

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

bindValue()source public

bindValue( string|integer $column , mixed $value , string|integer $type 'string' )

Присваивает значение позиционному или именованному параметру в подготовленном запросе. При использовании позиционных параметров необходимо начинать с индекса один, при использовании именованных параметров используйте имя в любом порядке.

Можно передавать совместимые с PDO константы для привязки значений с типом или, по желанию, любое имя типа, зарегистрированное в классе Type. Любое значение будет преобразовано в соответствующее представление типа при необходимости.

Комбинировать позиционные и именованные параметры в одном запросе запрещено.

Примеры:

$statement->bindValue(1, 'a title');
$statement->bindValue(2, 5, PDO::INT);
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');

Параметры

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

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

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

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']

Параметры

строка $type необязательно 'num'
'num' для позиционных столбцов, assoc для именованных столбцов

Возвращает

массив|false

Массив результатов, содержащий столбцы и значения, или false, если результатов нет


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

Cake\Database\Statement\StatementDecorator::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']]

Параметры

строка $type необязательно 'num'
num для извлечения столбцов как позиционных ключей или assoc для имён столбцов как ключей

Возвращает

массив
список всех результатов из базы данных для этого запроса

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

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

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

__get()source public

__get( string $property )

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

Параметры

строка $property
внутреннее свойство для получения

Возвращает

смешанный тип

bind()source public

bind( array $params , array $types )

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

Параметры

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

Реализация

Cake\Database\StatementInterface::bind()

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

Возвращает

целое число

Реализация

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
список значений для привязки к запросу

Возвращает

булево значение
true при успехе, false в противном случае

Реализация

Cake\Database\StatementInterface::execute()

getInnerStatement()source public

getInnerStatement( )

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

Возвращает

Cake\Database\StatementInterface|PDOStatement
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

© 2005–2018 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.5/class-Cake.Database.Statement.PDOStatement.html

Spec-Zone.ru

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