Spec-Zone.ru › CakePHP 3.1

Класс PDOStatement

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

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

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

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

bindValuesource 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');

Параметры

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

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

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

fetchsource 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 для именованных столбцов

Возвращает

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

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

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

fetchAllsource 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\Statement\StatementDecorator::fetchAll()

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

__getsource public

__get( string $property )

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

Параметры

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

Возвращает

mixed
смешанное

bindsource public

bind( array $params , array $types )

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

Параметры

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

Реализация

Cake\Database\StatementInterface::bind()

closeCursorsource public

closeCursor( )

Закрывает курсор в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вам не нужно вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.

Реализация

Cake\Database\StatementInterface::closeCursor()

columnCountsource public

columnCount( )

Возвращает количество столбцов, которые будут содержать результаты этого запроса.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Возвращает

integer
int

Реализация

Cake\Database\StatementInterface::columnCount()

countsource public

count( )

Запросы могут быть переданы в качестве аргумента для count() для возвращения количества затронутых строк из последнего выполнения.

Возвращает

integer
int

Реализация

Cake\Database\StatementInterface::count()

errorCodesource public

errorCode( )

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

Возвращает

integer|string
int|string

Реализация

Cake\Database\StatementInterface::errorCode()

errorInfosource public

errorInfo( )

Возвращает информацию об ошибке для последней ошибки, возникшей при выполнении этого запроса.

Возвращает

array
массив

Реализация

Cake\Database\StatementInterface::errorInfo()

executesource public

execute( array|null $params null )

Выполняет запрос, отправляя SQL-запрос в базу данных. Он может по желанию принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакого пользовательского преобразования типа, как это обычно происходит при вызове bindValue.

Параметры

array|null $params необязательно null
список значений, которые должны быть привязаны к запросу

Возвращает

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

Реализация

Cake\Database\StatementInterface::execute()

getInnerStatementsource public

getInnerStatement( )

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

getIteratorsource public

getIterator( )

Запросы итерируемы как массивы, этот метод вернёт объект итератора для обхода всех элементов в результате.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Возвращает

Iterator
\Iterator

Реализация

IteratorAggregate::getIterator()
END_OF_DOCUMENT_MARKER

lastInsertIdsource public

lastInsertId( string|null $table null , string|null $column null )

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

Параметры

string|null $table необязательно null
Название таблицы или последовательности, чтобы получить последнее значение вставки.
string|null $column необязательно null
Название столбца, представляющего первичный ключ.

Возвращает

string
string

Реализация

Cake\Database\StatementInterface::lastInsertId()

rowCountsource public

rowCount( )

Возвращает количество строк, затронутых этим SQL-заявлением.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Возвращает

integer
int

Реализация

Cake\Database\StatementInterface::rowCount()

Методы, используемые из Cake\Database\TypeConverterTrait

castsource public

cast( mixed $value , Cake\Database\Type|string $type )

Преобразует заданное значение в подходящее значение базы данных на основе типа и возвращает соответствующий внутренний тип утверждения.

Параметры

mixed $value
Значение для преобразования.
Cake\Database\Type|string $type
Имя типа или экземпляр типа для использования.

Возвращает

array
Список, содержащий преобразованное значение и внутренний тип

matchTypessource public

matchTypes( array $columns , array $types )

Сопоставляет столбцы с соответствующими типами.

И $columns, и $types должны быть либо числовыми, либо строковыми ключами одновременно.

Параметры

array $columns
Список или ассоциативный массив столбцов и параметров, которые нужно связать с типами.
array $types
Список или ассоциативный массив типов.

Возвращает

array
Массив

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

$_driversource

protected Cake\Database\Driver

Ссылка на объект драйвера, связанный с этим утверждением.

$_hasExecutedsource

protected boolean

Выполнялось ли это утверждение ранее

false

$_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.1/class-Cake.Database.Statement.PDOStatement.html

Spec-Zone.ru

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