Skip to content

Commit 632638a

Browse files
darkdefdarkdef
committed
review update
1 parent 0d24f90 commit 632638a

File tree

7 files changed

+32
-32
lines changed

7 files changed

+32
-32
lines changed

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
- Enh #784: Remove unused code in `AbstractSchema::getTableIndexes()` (@vjik)
1717
- Bug #788: Fix casting integer to string in `AbstractCommand::getRawSql()` (@Tigrov)
1818
- Enh #789: Remove unnecessary type casting to array in `AbstractDMLQueryBuilder::getTableUniqueColumnNames()` (@Tigrov)
19-
- Enh #794: Add category to log context (@darkdef)
19+
- Enh #794: Add message type to log context (@darkdef)
2020

2121
## 1.2.0 November 12, 2023
2222

‎docs/en/connection/logger.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,13 @@ If you need to redefine logger messages or increase/decrease logging level:
7474

7575
declare(strict_types=1);
7676

77-
use Yiisoft\Db\Driver\Pdo\LogTypes;
77+
use Yiisoft\Db\Driver\Pdo\LogType;
7878

7979
class MyLogger extends ParentLoggerClass implements LoggerInterface
8080
{
8181
public function log($level, string|\Stringable $message, array $context = []): void
8282
{
83-
if ($context[LogTypes::KEY] === LogTypes::TYPE_QUERY) {
83+
if ($context[LogType::LOG_TYPE] === LogType::QUERY) {
8484
... your logic here
8585
}
8686
}

‎src/Driver/Pdo/AbstractPdoCommand.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ protected function queryInternal(int $queryMode): mixed
259259
{
260260
$logCategory = self::class . '::' . $this->getQueryMode($queryMode);
261261

262-
$this->logger?->log(LogLevel::INFO, $rawSql = $this->getRawSql(), [$logCategory, LogTypes::KEY => LogTypes::TYPE_QUERY]);
262+
$this->logger?->log(LogLevel::INFO, $rawSql = $this->getRawSql(), [$logCategory, LogType::LOG_TYPE => LogType::QUERY]);
263263

264264
$queryContext = new CommandContext(__METHOD__, $logCategory, $this->getSql(), $this->getParams());
265265

‎src/Driver/Pdo/AbstractPdoConnection.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,13 @@ public function open(): void
101101
$connectionContext = new ConnectionContext(__METHOD__);
102102

103103
try {
104-
$this->logger?->log(LogLevel::INFO, $token, [LogTypes::KEY => LogTypes::TYPE_CONNECTION]);
104+
$this->logger?->log(LogLevel::INFO, $token, [LogType::LOG_TYPE => LogType::CONNECTION]);
105105
$this->profiler?->begin($token, $connectionContext);
106106
$this->initConnection();
107107
$this->profiler?->end($token, $connectionContext);
108108
} catch (PDOException $e) {
109109
$this->profiler?->end($token, $connectionContext->setException($e));
110-
$this->logger?->log(LogLevel::ERROR, $token, [LogTypes::KEY => LogTypes::TYPE_CONNECTION]);
110+
$this->logger?->log(LogLevel::ERROR, $token, [LogType::LOG_TYPE => LogType::CONNECTION]);
111111

112112
throw new Exception($e->getMessage(), (array) $e->errorInfo, $e);
113113
}
@@ -119,7 +119,7 @@ public function close(): void
119119
$this->logger?->log(
120120
LogLevel::DEBUG,
121121
'Closing DB connection: ' . $this->driver->getDsn() . ' ' . __METHOD__,
122-
[LogTypes::KEY => LogTypes::TYPE_CONNECTION],
122+
[LogType::LOG_TYPE => LogType::CONNECTION],
123123
);
124124

125125
$this->pdo = null;
@@ -226,7 +226,7 @@ protected function rollbackTransactionOnLevel(TransactionInterface $transaction,
226226
try {
227227
$transaction->rollBack();
228228
} catch (Throwable $e) {
229-
$this->logger?->log(LogLevel::ERROR, (string) $e, [__METHOD__, LogTypes::KEY => LogTypes::TYPE_TRANSACTION]);
229+
$this->logger?->log(LogLevel::ERROR, (string) $e, [__METHOD__, LogType::LOG_TYPE => LogType::TRANSACTION]);
230230
/** hide this exception to be able to continue throwing original exception outside */
231231
}
232232
}

‎src/Driver/Pdo/AbstractPdoTransaction.php

+10-10
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public function begin(string $isolationLevel = null): void
6161
LogLevel::DEBUG,
6262
'Begin transaction' . ($isolationLevel ? ' with isolation level ' . $isolationLevel : '')
6363
. ' ' . __METHOD__,
64-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
64+
[LogType::LOG_TYPE => LogType::TRANSACTION]
6565
);
6666

6767
$this->db->getPDO()?->beginTransaction();
@@ -74,15 +74,15 @@ public function begin(string $isolationLevel = null): void
7474
$this->logger?->log(
7575
LogLevel::DEBUG,
7676
'Set savepoint ' . $this->level . ' ' . __METHOD__,
77-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
77+
[LogType::LOG_TYPE => LogType::TRANSACTION]
7878
);
7979

8080
$this->createSavepoint('LEVEL' . $this->level);
8181
} else {
8282
$this->logger?->log(
8383
LogLevel::DEBUG,
8484
'Transaction not started: nested transaction not supported ' . __METHOD__,
85-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
85+
[LogType::LOG_TYPE => LogType::TRANSACTION]
8686
);
8787

8888
throw new NotSupportedException('Transaction not started: nested transaction not supported.');
@@ -103,7 +103,7 @@ public function commit(): void
103103
$this->logger?->log(
104104
LogLevel::DEBUG,
105105
'Commit transaction ' . __METHOD__,
106-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
106+
[LogType::LOG_TYPE => LogType::TRANSACTION]
107107
);
108108
$this->db->getPDO()?->commit();
109109

@@ -114,14 +114,14 @@ public function commit(): void
114114
$this->logger?->log(
115115
LogLevel::DEBUG,
116116
'Release savepoint ' . $this->level . ' ' . __METHOD__,
117-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
117+
[LogType::LOG_TYPE => LogType::TRANSACTION]
118118
);
119119
$this->releaseSavepoint('LEVEL' . $this->level);
120120
} else {
121121
$this->logger?->log(
122122
LogLevel::INFO,
123123
'Transaction not committed: nested transaction not supported ' . __METHOD__,
124-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
124+
[LogType::LOG_TYPE => LogType::TRANSACTION]
125125
);
126126
}
127127
}
@@ -153,7 +153,7 @@ public function rollBack(): void
153153
$this->logger?->log(
154154
LogLevel::INFO,
155155
'Roll back transaction ' . __METHOD__,
156-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
156+
[LogType::LOG_TYPE => LogType::TRANSACTION]
157157
);
158158
$this->db->getPDO()?->rollBack();
159159

@@ -164,14 +164,14 @@ public function rollBack(): void
164164
$this->logger?->log(
165165
LogLevel::DEBUG,
166166
'Roll back to savepoint ' . $this->level . ' ' . __METHOD__,
167-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
167+
[LogType::LOG_TYPE => LogType::TRANSACTION]
168168
);
169169
$this->rollBackSavepoint('LEVEL' . $this->level);
170170
} else {
171171
$this->logger?->log(
172172
LogLevel::INFO,
173173
'Transaction not rolled back: nested transaction not supported ' . __METHOD__,
174-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
174+
[LogType::LOG_TYPE => LogType::TRANSACTION]
175175
);
176176
}
177177
}
@@ -185,7 +185,7 @@ public function setIsolationLevel(string $level): void
185185
$this->logger?->log(
186186
LogLevel::DEBUG,
187187
'Setting transaction isolation level to ' . $this->level . ' ' . __METHOD__,
188-
[LogTypes::KEY => LogTypes::TYPE_TRANSACTION]
188+
[LogType::LOG_TYPE => LogType::TRANSACTION]
189189
);
190190
$this->setTransactionIsolationLevel($level);
191191
}

‎src/Driver/Pdo/LogType.php

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Yiisoft\Db\Driver\Pdo;
6+
7+
final class LogType
8+
{
9+
public const LOG_TYPE = 'log-type';
10+
11+
public const CONNECTION = 'connection';
12+
public const QUERY = 'query';
13+
public const TRANSACTION = 'transaction';
14+
}

‎src/Driver/Pdo/LogTypes.php

-14
This file was deleted.

0 commit comments

Comments
 (0)