Spec-Zone.ru › CakePHP 4.3

Класс LoggingStatement

Декоратор оператора, используемый для

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

Константы

  • string
    FETCH_TYPE_ASSOC 
    'assoc'

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

  • string
    FETCH_TYPE_NUM 
    'num'

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

  • string
    FETCH_TYPE_OBJ 
    'obj'

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

Резюме свойств

  • $_compiledParams protected
    array<array>

    Хранит привязанные параметры

  • $_driver protected
    Cake\Database\DriverInterface

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

  • $_hasExecuted protected
    bool

    Выполнялся ли этот оператор ранее

  • $_logger protected
    Psr\Log\LoggerInterface

    Объект логгера, ответственный за выполнение задачи логирования

  • $_statement protected
    Cake\Database\StatementInterface

    Реализация объекта оператора, например PDOStatement или любая другая пользовательская реализация.

  • $loggedQuery protected
    Cake\Database\Log\LoggedQuery|null

    Залогированный запрос

  • $queryString public @property-read
    string
  • $startTime protected
    float

    Время начала выполнения запроса.

Резюме методов

  • __construct() public

    Конструктор

  • __get() public

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

  • _log() protected

    Копирует данные логирования в переданный LoggedQuery и отправляет их в систему логирования.

  • bind() public

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

  • bindValue() public

    Обёртка для функции bindValue для сбора каждого параметра, который будет позже использован в функции логгера.

  • cast() public

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

  • closeCursor() public

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

  • columnCount() public

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

  • count() public

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

  • errorCode() public

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

  • errorInfo() public

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

  • execute() public

    Обёртка для функции execute для расчёта затраченного времени и последующего логирования запроса.

  • fetch() public

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

  • fetchAll() public

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

  • fetchAssoc() public

    Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается пустой массив.

  • fetchColumn() public

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

  • getInnerStatement() public

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

  • getIterator() public

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

  • getLogger() public

    Возвращает объект логгера

  • lastInsertId() public

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

  • matchTypes() public

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

  • rowCount() public

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

  • setLogger() public

    Устанавливает логгер

END_OF_DOCUMENT_MARKER

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

__construct() public 

__construct(Cake\Database\StatementInterface $statement, Cake\Database\DriverInterface $driver)

Конструктор

Параметры

Cake\Database\StatementInterface $statement

Реализация запроса, например, PDOStatement.

Cake\Database\DriverInterface $driver

Экземпляр драйвера

__get() public 

__get(string $property): string|null

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

Параметры

string $property

Внутреннее свойство для получения

Возвращает

string|null

_log() protected 

_log(): void

Копирует данные логирования в переданный LoggedQuery и отправляет их в систему логирования.

Возвращает

void

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

Обёртка для функции bindValue для сбора каждого параметра для последующего использования в функции logger.

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

Примеры:

$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 optional

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

Возвращает

void

cast() public 

cast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): array

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

Параметры

mixed $value

Значение для преобразования

Cake\Database\TypeInterface|string|int $type optional

Имя типа или экземпляр типа для использования.

Возвращает

array

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

Обёртка для функции execute для расчёта затраченного времени и последующего логирования запроса.

Параметры

array|null $params optional

Список значений, которые должны быть привязаны к запросу

Возвращает

bool

Выбрасывает

Exception
Перебрасывает любое исключение, возникшее во время выполнения запроса.

fetch() public 

fetch(string|int $type = self::FETCH_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 optional

Возвращает

mixed

fetchAll() public 

fetchAll(string|int $type = self::FETCH_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 optional

Возвращает

array|false

fetchAssoc() public 

fetchAssoc(): array

Возвращает следующую строку в наборе результатов как ассоциативный массив. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результаты не найдены, возвращается пустой массив.

Возвращает

array

fetchColumn() public 

fetchColumn(int $position): mixed

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

Параметры

int $position

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

Возвращает

mixed

getInnerStatement() public 

getInnerStatement(): Cake\Database\StatementInterface

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

Возвращает

Cake\Database\StatementInterface

getIterator() public 

getIterator(): Cake\Database\StatementInterface

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

Пример:

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

Возвращает

Cake\Database\StatementInterface

getLogger() public 

getLogger(): Psr\Log\LoggerInterface

Получает объект логгера

Возвращает

Psr\Log\LoggerInterface

lastInsertId() public 

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

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

Параметры

string|null $table optional

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

string|null $column optional

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

Возвращает

string|int

matchTypes() public 

matchTypes(array $columns, array $types): array

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

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

Параметры

array $columns

Список или ассоциативный массив столбцов и параметров, которые будут привязаны с типами

array $types

Список или ассоциативный массив типов

Возвращает

array

rowCount() public 

rowCount(): int

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

Пример:

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

Возвращает

int

setLogger() public 

setLogger(Psr\Log\LoggerInterface $logger): void

Устанавливает логгер

Параметры

Psr\Log\LoggerInterface $logger

Объект логгера

Возвращает

void

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

$_compiledParams protected

Хранит связанные параметры

Тип

array<array>

$_driver protected

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

Тип

Cake\Database\DriverInterface

$_hasExecuted protected

Выполнялся ли этот оператор ранее

Тип

bool

$_logger protected

Экземпляр логгера, ответственный за выполнение задач логирования

Тип

Psr\Log\LoggerInterface

$_statement protected

Реализация экземпляра оператора, например PDOStatement или любая другая пользовательская реализация.

Тип

Cake\Database\StatementInterface

$loggedQuery protected

Залогированный запрос

Тип

Cake\Database\Log\LoggedQuery|null

$queryString public @property-read

Тип

string

$startTime protected

Время начала выполнения запроса.

Тип

float

© 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.3/class-Cake.Database.Log.LoggingStatement.html

Spec-Zone.ru

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