Spec-Zone.ru › CakePHP 4.4

Интерфейс StatementInterface

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

Пространство имён: Cake\Database

Константы

  • string
    FETCH_TYPE_ASSOC 
    'assoc'

    Используется для обозначения возвращаемого ассоциативного массива в результате вызова методов fetch

  • string
    FETCH_TYPE_NUM 
    'num'

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

  • string
    FETCH_TYPE_OBJ 
    'obj'

    Используется для обозначения возвращаемого объекта stdClass в результате вызова методов fetch

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

  • $queryString public @property-read
    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

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

  • fetchColumn() public

    Возвращает значение результата в заданной позиции.

  • lastInsertId() public

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

  • rowCount() public

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

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

bind() public 

bind(array $params, array $types): void

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

Параметры

array $params

список значений для привязки

array $types

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

Возвращаемое значение

void

bindValue() public 

bindValue(string|int $column, mixed $value, string|int|null $type = 'string'): void

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

Не разрешается комбинировать позиционные и именованные переменные в одной инструкции

Примеры:

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

Параметры

string|int $column

имя или позиция параметра для привязки

mixed $value

Значение для привязки к переменной в запросе

string|int|null $type необязательно

имя настроенного класса типа или константа типа PDO.

Возвращаемое значение

void

closeCursor() public 

closeCursor(): void

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

Возвращаемое значение

void

columnCount() public 

columnCount(): int

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

Пример:

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

Возвращаемое значение

int

count() public 

count(): int

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

Возвращаемое значение

int

errorCode() public 

errorCode(): string|int

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

Возвращаемое значение

string|int

errorInfo() public 

errorInfo(): array

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

Возвращаемое значение

array

execute() public 

execute(array|null $params = null): bool

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

Параметры

array|null $params необязательно

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

Возвращаемое значение

bool

fetch() public 

fetch(string|int $type = 'num'): mixed

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
 $statement->execute();
 print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Параметры

string|int $type необязательно

'num' для позиционных столбцов, assoc для именованных столбцов или константы режима извлечения PDO.

Возвращаемое значение

mixed

fetchAll() public 

fetchAll(string|int $type = 'num'): array|false

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
 $statement->execute();
 print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Параметры

string|int $type необязательно

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

Возвращаемое значение

array|false

fetchColumn() public 

fetchColumn(int $position): mixed

Возвращает значение результата в заданной позиции.

Параметры

int $position

Числовая позиция столбца для извлечения в результате

Возвращаемое значение

mixed

lastInsertId() public 

lastInsertId(string|null $table = null, string|null $column = null): string|int

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

Параметры

string|null $table необязательно

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

string|null $column необязательно

имя столбца, представляющего первичный ключ

Возвращаемое значение

string|int

rowCount() public 

rowCount(): int

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

Пример:

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

Возвращаемое значение

int

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

$queryString public @property-read

Тип

string

© 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/4.4/interface-Cake.Database.StatementInterface.html

Spec-Zone.ru

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