AbstractPdoConnection::getPDO() - Code Metrics - Inspection of "Better naming classes with `PDO` - part 2." - yiisoft/db - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#671)

by Wilmer

created 2023-04-06 23:36 UTC

AbstractPdoConnection::getPDO() A

↳ Parent: AbstractPdoConnection

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Driver\Pdo;

use PDO;
use PDOException;
use Psr\Log\LogLevel;
use Yiisoft\Db\Cache\SchemaCache;
use Yiisoft\Db\Connection\AbstractConnection;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidCallException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Profiler\Context\ConnectionContext;
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
use Yiisoft\Db\Schema\QuoterInterface;
use Yiisoft\Db\Schema\SchemaInterface;

use function array_keys;
use function is_string;

/**
 * Represents a connection to a database using the PDO (PHP Data Objects) extension.
 *
 * It provides a set of methods for interacting with a database using PDO, such as executing SQL statements, preparing
 * and executing statements, and managing transactions.
 *
 * The ConnectionPDO classes extend from this class, which is a base class for representing a connection to a database.
 *
 * It implements the ConnectionInterface, which defines the interface for interacting with a database connection.
 */
abstract class AbstractPdoConnection extends AbstractConnection implements PdoConnectionInterface
{
    protected PDO|null $pdo = null;
    protected string $serverVersion = '';
    protected bool|null $emulatePrepare = null;
    protected QueryBuilderInterface|null $queryBuilder = null;
    protected QuoterInterface|null $quoter = null;
    protected SchemaInterface|null $schema = null;

    public function __construct(protected PdoDriverInterface $driver, protected SchemaCache $schemaCache)
    {
    }

    /**
     * Reset the connection after cloning.
     */
    public function __clone()
    {
        $this->transaction = null;
        $this->pdo = null;
    }

    /**
     * Close the connection before serializing.
     */
    public function __sleep(): array
    {
        $fields = (array) $this;

        unset(
            $fields["\000*\000" . 'pdo'],
            $fields["\000*\000" . 'transaction'],
            $fields["\000*\000" . 'schema']
        );

        return array_keys($fields);
    }

    public function open(): void
    {
        if ($this->pdo instanceof PDO) {
            return;
        }

        if ($this->driver->getDsn() === '') {
            throw new InvalidConfigException('Connection::dsn cannot be empty.');
        }

        $token = 'Opening DB connection: ' . $this->driver->getDsn();
        $connectionContext = new ConnectionContext(__METHOD__);

        try {
            $this->logger?->log(LogLevel::INFO, $token);
            $this->profiler?->begin($token, $connectionContext);
            $this->initConnection();
            $this->profiler?->end($token, $connectionContext);
        } catch (PDOException $e) {
            $this->profiler?->end($token, $connectionContext->setException($e));
            $this->logger?->log(LogLevel::ERROR, $token);

            throw new Exception($e->getMessage(), (array) $e->errorInfo, $e);
        }
    }

    public function close(): void
    {
        if ($this->pdo !== null) {
            $this->logger?->log(
                LogLevel::DEBUG,
                'Closing DB connection: ' . $this->driver->getDsn() . ' ' . __METHOD__,
            );

            $this->pdo = null;
            $this->transaction = null;
        }
    }

    public function getDriver(): PdoDriverInterface
    {
        return $this->driver;
    }

    public function getEmulatePrepare(): bool|null
    {
        return $this->emulatePrepare;
    }

    public function getActivePDO(string|null $sql = '', bool|null $forRead = null): PDO
    {
        $this->open();
        $pdo = $this->getPDO();

        if ($pdo === null) {
            throw new Exception('PDO cannot be initialized.');
        }

        return $pdo;
    }

    public function getPDO(): PDO|null
    {
        return $this->pdo;
    }

    public function getLastInsertID(string $sequenceName = null): string
    {
        if ($this->pdo !== null) {
            return $this->pdo->lastInsertID($sequenceName ?? null);
        }

        throw new InvalidCallException('DB Connection is not active.');
    }

    public function getDriverName(): string
    {
        return $this->driver->getDriverName();
    }

    public function getServerVersion(): string
    {
        if ($this->serverVersion === '') {
            /** @psalm-var mixed $version */
            $version = $this->getActivePDO()->getAttribute(PDO::ATTR_SERVER_VERSION);
            $this->serverVersion = is_string($version) ? $version : 'Version could not be determined.';
        }

        return $this->serverVersion;
    }

    public function isActive(): bool
    {
        return $this->pdo !== null;
    }

    public function quoteValue(mixed $value): mixed
    {
        if (is_string($value) === false) {
            return $value;
        }

        return $this->getActivePDO()->quote($value);
    }

    public function setEmulatePrepare(bool $value): void
    {
        $this->emulatePrepare = $value;
    }

    /**
     * Initializes the DB connection.
     *
     * This method is invoked right after the DB connection is established.
     *
     * The default implementation turns on `PDO::ATTR_EMULATE_PREPARES`, if {@see getEmulatePrepare()} is `true`.
     */
    protected function initConnection(): void
    {
        if ($this->getEmulatePrepare() !== null) {
            $this->driver->attributes([PDO::ATTR_EMULATE_PREPARES => $this->getEmulatePrepare()]);
        }

        $this->pdo = $this->driver->createConnection();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Db\Driver\Pdo;
6
7			use PDO;
8			use PDOException;
9			use Psr\Log\LogLevel;
10			use Yiisoft\Db\Cache\SchemaCache;
11			use Yiisoft\Db\Connection\AbstractConnection;
12			use Yiisoft\Db\Exception\Exception;
13			use Yiisoft\Db\Exception\InvalidCallException;
14			use Yiisoft\Db\Exception\InvalidConfigException;
15			use Yiisoft\Db\Profiler\Context\ConnectionContext;
16			use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
17			use Yiisoft\Db\Schema\QuoterInterface;
18			use Yiisoft\Db\Schema\SchemaInterface;
19
20			use function array_keys;
21			use function is_string;
22
23			/**
24			* Represents a connection to a database using the PDO (PHP Data Objects) extension.
25			*
26			* It provides a set of methods for interacting with a database using PDO, such as executing SQL statements, preparing
27			* and executing statements, and managing transactions.
28			*
29			* The ConnectionPDO classes extend from this class, which is a base class for representing a connection to a database.
30			*
31			* It implements the ConnectionInterface, which defines the interface for interacting with a database connection.
32			*/
33			abstract class AbstractPdoConnection extends AbstractConnection implements PdoConnectionInterface
34			{
35			protected PDO\|null $pdo = null;
36			protected string $serverVersion = '';
37			protected bool\|null $emulatePrepare = null;
38			protected QueryBuilderInterface\|null $queryBuilder = null;
39			protected QuoterInterface\|null $quoter = null;
40			protected SchemaInterface\|null $schema = null;
41
42			public function __construct(protected PdoDriverInterface $driver, protected SchemaCache $schemaCache)
43			{
44			}
45
46			/**
47			* Reset the connection after cloning.
48			*/
49			public function __clone()
50			{
51			$this->transaction = null;
52			$this->pdo = null;
53			}
54
55			/**
56			* Close the connection before serializing.
57			*/
58			public function __sleep(): array
59			{
60			$fields = (array) $this;
61
62			unset(
63			$fields["\000*\000" . 'pdo'],
64			$fields["\000*\000" . 'transaction'],
65			$fields["\000*\000" . 'schema']
66			);
67
68			return array_keys($fields);
69			}
70
71			public function open(): void
72			{
73			if ($this->pdo instanceof PDO) {
74			return;
75			}
76
77			if ($this->driver->getDsn() === '') {
78			throw new InvalidConfigException('Connection::dsn cannot be empty.');
79			}
80
81			$token = 'Opening DB connection: ' . $this->driver->getDsn();
82			$connectionContext = new ConnectionContext(__METHOD__);
83
84			try {
85			$this->logger?->log(LogLevel::INFO, $token);
86			$this->profiler?->begin($token, $connectionContext);
87			$this->initConnection();
88			$this->profiler?->end($token, $connectionContext);
89			} catch (PDOException $e) {
90			$this->profiler?->end($token, $connectionContext->setException($e));
91			$this->logger?->log(LogLevel::ERROR, $token);
92
93			throw new Exception($e->getMessage(), (array) $e->errorInfo, $e);
94			}
95			}
96
97			public function close(): void
98			{
99			if ($this->pdo !== null) {
100			$this->logger?->log(
101			LogLevel::DEBUG,
102			'Closing DB connection: ' . $this->driver->getDsn() . ' ' . __METHOD__,
103			);
104
105			$this->pdo = null;
106			$this->transaction = null;
107			}
108			}
109
110			public function getDriver(): PdoDriverInterface
111			{
112			return $this->driver;
113			}
114
115			public function getEmulatePrepare(): bool\|null
116			{
117			return $this->emulatePrepare;
118			}
119
120			public function getActivePDO(string\|null $sql = '', bool\|null $forRead = null): PDO
121			{
122			$this->open();
123			$pdo = $this->getPDO();
124
125			if ($pdo === null) {
126			throw new Exception('PDO cannot be initialized.');
127			}
128
129			return $pdo;
130			}
131
132			public function getPDO(): PDO\|null
133			{
134			return $this->pdo;
135			}
136
137			public function getLastInsertID(string $sequenceName = null): string
138			{
139			if ($this->pdo !== null) {
140			return $this->pdo->lastInsertID($sequenceName ?? null);
141			}
142
143			throw new InvalidCallException('DB Connection is not active.');
144			}
145
146			public function getDriverName(): string
147			{
148			return $this->driver->getDriverName();
149			}
150
151			public function getServerVersion(): string
152			{
153			if ($this->serverVersion === '') {
154			/** @psalm-var mixed $version */
155			$version = $this->getActivePDO()->getAttribute(PDO::ATTR_SERVER_VERSION);
156			$this->serverVersion = is_string($version) ? $version : 'Version could not be determined.';
157			}
158
159			return $this->serverVersion;
160			}
161
162			public function isActive(): bool
163			{
164			return $this->pdo !== null;
165			}
166
167			public function quoteValue(mixed $value): mixed
168			{
169			if (is_string($value) === false) {
170			return $value;
171			}
172
173			return $this->getActivePDO()->quote($value);
174			}
175
176			public function setEmulatePrepare(bool $value): void
177			{
178			$this->emulatePrepare = $value;
179			}
180
181			/**
182			* Initializes the DB connection.
183			*
184			* This method is invoked right after the DB connection is established.
185			*
186			* The default implementation turns on `PDO::ATTR_EMULATE_PREPARES`, if {@see getEmulatePrepare()} is `true`.
187			*/
188			protected function initConnection(): void
189			{
190			if ($this->getEmulatePrepare() !== null) {
191			$this->driver->attributes([PDO::ATTR_EMULATE_PREPARES => $this->getEmulatePrepare()]);
192			}
193
194			$this->pdo = $this->driver->createConnection();
195			}
196			}
197

yiisoft / db

Pull Request — master (#671)

AbstractPdoConnection::getPDO() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like