Spec-Zone.ru › CakePHP 3.7

Интерфейс StatementInterface

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

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

  • Cake\Database\Statement\BufferedStatement
  • Cake\Database\Statement\StatementDecorator

Непрямые реализаторы

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

Краткое описание констант

  • string

    FETCH_TYPE_ASSOC
    'assoc'
  • string

    FETCH_TYPE_NUM
    'num'
  • string

    FETCH_TYPE_OBJ
    'obj'

Краткое описание магических свойств

  • $queryString public
    string

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

  • 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
список значений, которые нужно привязать к запросу

Возвращает

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


END_OF_DOCUMENT_MARKER ```

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

Возвращает

строка

rowCount()source public

rowCount( )

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

Пример:

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

Возвращает

целое число

Подробное описание магических свойств

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

Spec-Zone.ru

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