Spec-Zone.ru › CakePHP 3.2

Интерфейс StatementInterface

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

Прямые реализаторы

  • Cake\Database\Statement\StatementDecorator

Косвенные реализаторы

  • Cake\Database\Statement\BufferedStatement
  • Cake\Database\Statement\CallbackStatement
  • Cake\Database\Statement\PDOStatement
Пространство имен: Cake\Database
Расположение: Database/StatementInterface.php

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

  • bind() public
    Связывает набор значений с объектом заявления с соответствующим типом
  • bindValue() public

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

  • closeCursor() public

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

  • columnCount() public
    Возвращает количество столбцов, которые будут содержать результаты этого заявления
  • count() public

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

  • errorCode() public
    Возвращает код ошибки для последней ошибки, произошедшей при выполнении этого заявления
  • errorInfo() public

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

  • execute() public

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

  • fetch() public

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

  • fetchAll() public
    Возвращает массив со всеми строками, полученными в результате выполнения этого заявления
  • lastInsertId() public
    Возвращает последний вставленный первичный ключ, используя это заявление
  • rowCount() public
    Возвращает количество затронутых строк этим SQL-заявлением

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

bind()source public

bind( array $params , array $types )

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

Параметры

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

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

Параметры

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

closeCursor()source public

closeCursor( )

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

columnCount()source public

columnCount( )

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

Пример:

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

Возвращает

целое число

count()source public

count( )

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

Возвращает

целое число

errorCode()source public

errorCode( )

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

Возвращает

целое число|строка

errorInfo()source public

errorInfo( )

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

Возвращает

массив

execute()source public

execute( array|null $params null )

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

Параметры

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

Возвращает

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

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, если результатов не осталось


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 для имен столбцов в качестве ключей

Возвращает

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

lastInsertId()source public

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

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

Параметры

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

Возвращает

строка
END_OF_DOCUMENT_MARKER

rowCount()source public

rowCount( )

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

Пример:

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

Возвращает

целое число

© 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.StatementInterface.html

Spec-Zone.ru

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