ConnectionPDO::initConnection() - Code Metrics - Inspection of "Remove duplicate of code" - yiisoft/db - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#410)

by Def

created 2022-12-11 08:28 UTC

ConnectionPDO::initConnection() A

↳ Parent: ConnectionPDO

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Driver\PDO;

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

use function array_keys;
use function is_string;

abstract class ConnectionPDO extends Connection implements ConnectionPDOInterface
{
    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 QueryCache $queryCache,
        protected SchemaCache $schemaCache
    ) {
        parent::__construct($queryCache);
    }

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

    /**
     * Close the connection before serializing.
     *
     * @return array
     */
    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 (!empty($this->pdo)) {
            return;
        }

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

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

        try {
            $this->logger?->log(LogLevel::INFO, $token);
            $this->profiler?->begin($token, [__METHOD__]);
            $this->initConnection();
            $this->profiler?->end($token, [__METHOD__]);
        } catch (PDOException $e) {
            $this->profiler?->end($token, [__METHOD__]);
            $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 getCacheKey(): array
    {
        return [$this->driver->getDsn(), $this->driver->getUsername()];
    }

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

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

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

    /**
     * Input variables $sql and $forRead needs for future implementation of Connection + Pool
     *
     * @throws Exception
     * @throws InvalidConfigException
     */
    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 getLastInsertID(string $sequenceName = null): string
    {
        if ($this->isActive() && $this->pdo) {
            return $this->pdo->lastInsertID(
                $sequenceName === null ? null : $this->getQuoter()->quoteTableName($sequenceName)
            );
        }

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

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

    /**
     * @throws Exception
     */
    public function getServerVersion(): string
    {
        if ($this->serverVersion === '') {
            /** @var mixed */
            $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)) {
            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 emulatePrepare} is true, and sets the database {@see charset} if it is not empty.
     */
    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\QueryCache;
11			use Yiisoft\Db\Cache\SchemaCache;
12			use Yiisoft\Db\Connection\Connection;
13			use Yiisoft\Db\Exception\Exception;
14			use Yiisoft\Db\Exception\InvalidCallException;
15			use Yiisoft\Db\Exception\InvalidConfigException;
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			abstract class ConnectionPDO extends Connection implements ConnectionPDOInterface
24			{
25			protected PDO\|null $pdo = null;
26			protected string $serverVersion = '';
27			protected bool\|null $emulatePrepare = null;
28			protected QueryBuilderInterface\|null $queryBuilder = null;
29			protected QuoterInterface\|null $quoter = null;
30			protected SchemaInterface\|null $schema = null;
31
32			public function __construct(
33			protected PDODriverInterface $driver,
34			protected QueryCache $queryCache,
35			protected SchemaCache $schemaCache
36			) {
37			parent::__construct($queryCache);
38			}
39
40			/**
41			* Reset the connection after cloning.
42			*/
43			public function __clone()
44			{
45			$this->transaction = null;
46			$this->pdo = null;
47			}
48
49			/**
50			* Close the connection before serializing.
51			*
52			* @return array
53			*/
54			public function __sleep(): array
55			{
56			$fields = (array) $this;
57
58			unset(
59			$fields["\000*\000" . 'pdo'],
60			$fields["\000*\000" . 'transaction'],
61			$fields["\000*\000" . 'schema']
62			);
63
64			return array_keys($fields);
65			}
66
67			public function open(): void
68			{
69			if (!empty($this->pdo)) {
70			return;
71			}
72
73			if (empty($this->driver->getDsn())) {
74			throw new InvalidConfigException('Connection::dsn cannot be empty.');
75			}
76
77			$token = 'Opening DB connection: ' . $this->driver->getDsn();
78
79			try {
80			$this->logger?->log(LogLevel::INFO, $token);
81			$this->profiler?->begin($token, [__METHOD__]);
82			$this->initConnection();
83			$this->profiler?->end($token, [__METHOD__]);
84			} catch (PDOException $e) {
85			$this->profiler?->end($token, [__METHOD__]);
86			$this->logger?->log(LogLevel::ERROR, $token);
87
88			throw new Exception($e->getMessage(), (array) $e->errorInfo, $e);
89			}
90			}
91
92			public function close(): void
93			{
94			if ($this->pdo !== null) {
95			$this->logger?->log(
96			LogLevel::DEBUG,
97			'Closing DB connection: ' . $this->driver->getDsn() . ' ' . __METHOD__,
98			);
99
100			$this->pdo = null;
101			$this->transaction = null;
102			}
103			}
104
105			public function getCacheKey(): array
106			{
107			return [$this->driver->getDsn(), $this->driver->getUsername()];
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 getPDO(): PDO\|null
121			{
122			return $this->pdo;
123			}
124
125			/**
126			* Input variables $sql and $forRead needs for future implementation of Connection + Pool
127			*
128			* @throws Exception
129			* @throws InvalidConfigException
130			*/
131			public function getActivePDO(string\|null $sql = '', bool\|null $forRead = null): PDO
132			{
133			$this->open();
134			$pdo = $this->getPDO();
135
136			if ($pdo === null) {
137			throw new Exception('PDO cannot be initialized.');
138			}
139
140			return $pdo;
141			}
142
143			public function getLastInsertID(string $sequenceName = null): string
144			{
145			if ($this->isActive() && $this->pdo) {
146			return $this->pdo->lastInsertID(
147			$sequenceName === null ? null : $this->getQuoter()->quoteTableName($sequenceName)
148			);
149			}
150
151			throw new InvalidCallException('DB Connection is not active.');
152			}
153
154			public function getName(): string
155			{
156			return $this->driver->getDriverName();
157			}
158
159			/**
160			* @throws Exception
161			*/
162			public function getServerVersion(): string
163			{
164			if ($this->serverVersion === '') {
165			/** @var mixed */
166			$version = $this->getActivePDO()->getAttribute(PDO::ATTR_SERVER_VERSION);
167			$this->serverVersion = is_string($version) ? $version : 'Version could not be determined.';
168			}
169
170			return $this->serverVersion;
171			}
172
173			public function isActive(): bool
174			{
175			return $this->pdo !== null;
176			}
177
178			public function quoteValue(mixed $value): mixed
179			{
180			if (!is_string($value)) {
181			return $value;
182			}
183
184			return $this->getActivePDO()->quote($value);
185			}
186
187			public function setEmulatePrepare(bool $value): void
188			{
189			$this->emulatePrepare = $value;
190			}
191
192			/**
193			* Initializes the DB connection.
194			*
195			* This method is invoked right after the DB connection is established.
196			*
197			* The default implementation turns on `PDO::ATTR_EMULATE_PREPARES`.
198			*
199			* if {@see emulatePrepare} is true, and sets the database {@see charset} if it is not empty.
200			*/
201			protected function initConnection(): void
202			{
203			if ($this->getEmulatePrepare() !== null) {
204			$this->driver->attributes([PDO::ATTR_EMULATE_PREPARES => $this->getEmulatePrepare()]);
205			}
206
207			$this->pdo = $this->driver->createConnection();
208			}
209			}
210

yiisoft / db

Pull Request — master (#410)

ConnectionPDO::initConnection() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like