DatabaseManager::getTransactionIsolation() - Code Metrics - Inspection of "Merge pull request #2 from webstream-framework/fea..." - webstream-framework/Database - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 76b08e...5cd6b2 )

by Ryuichi

created 2020-08-09 06:02 UTC

DatabaseManager::getTransactionIsolation() A

↳ Parent: DatabaseManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10

<?php

namespace WebStream\Database;

use WebStream\DI\Injector;
filter:
    dependency_paths: ["lib/*"]
use WebStream\Container\Container;
filter:
    dependency_paths: ["lib/*"]
use WebStream\Exception\Extend\DatabaseException;
filter:
    dependency_paths: ["lib/*"]
use WebStream\Database\Driver\DatabaseDriver;
use Doctrine\DBAL\TransactionIsolationLevel;

/**
 * DatabaseManager
 * @author Ryuichi TANAKA.
 * @since 2013/12/07
 * @version 0.4
 */
class DatabaseManager
{
    use Injector;

    /**
     * @var ConnectionManager コネクションマネージャ
     */
    private $connectionManager;

    /**
     * @var DatabaseDriver データベースコネクション
     */
    private $connection;

    /**
     * @var bool 自動コミットフラグ
     */
    private $isAutoCommit;

    /**
     * @var Query クエリオブジェクト
     */
    private $query;

    /**
     * @var Logger ロガー
filter:
    dependency_paths: ["lib/*"]
     */
    private $logger;

    /**
     * constructor
     * @param Container 依存コンテナ

     */
    public function __construct(Container $container)
    {
        $this->connectionManager = new ConnectionManager($container);
        $this->logger = $container->logger;
        $this->isAutoCommit = false;
    }

    /**
     * destructor
     */
    public function __destruct()
    {
        $this->disconnect();
        $this->query = null;
    }

    /**
     * データベース接続する
     * すでに接続中であれば再接続はしない
     */
    public function connect()
    {
        try {
            $this->connection->connect();
            $this->query = new Query($this->connection);
            $this->query->inject('logger', $this->logger);
        } catch (\PDOException $e) {
            throw new DatabaseException($e);
        }
    }

    /**
     * データベース切断する
     */
    public function disconnect()
    {
        if ($this->connection === null) {
            return;
        }

        if ($this->inTransaction()) {
            // トランザクションが明示的に開始された状態でcommit/rollbackが行われていない場合
            // ログに警告を書き込み、強制的にロールバックする
            $this->connection->rollback();
            $this->logger->warn("Not has been executed commit or rollback after the transaction started.");
        }

        $this->connection->disconnect();
        $this->connection = null;
    }

    /**
     * トランザクションを開始する
     * @param int $isolationLevel トランザクション分離レベル
     */
    public function beginTransaction(int $isolationLevel)
    {
        // 既にトランザクションが開始されている場合、継続しているトランザクションを有効のままにする
        // トランザクションを破棄して再度開始する場合は明示的に破棄してから再呼び出しする
        if ($this->inTransaction()) {
            $this->logger->debug("Transaction already started.");

            return;
        }

        if (!$this->connection->beginTransaction()) {
            throw new DatabaseException("Failed to start transaction.");
        }

        $this->connection->setAutoCommit($this->isAutoCommit);

        if (
            $isolationLevel === TransactionIsolationLevel::READ_UNCOMMITTED ||
            $isolationLevel === TransactionIsolationLevel::READ_COMMITTED ||
            $isolationLevel === TransactionIsolationLevel::REPEATABLE_READ ||
            $isolationLevel === TransactionIsolationLevel::SERIALIZABLE
        ) {
            $this->connection->setTransactionIsolation($isolationLevel);
        } else {
            throw new DatabaseException("Invalid transaction isolation level: " . $isolationLevel);
        }

        $this->logger->debug("Transaction start.");
    }

    /**
     * コミットする
     */
    public function commit()
    {
        try {
            if ($this->connection !== null) {
                if ($this->inTransaction()) {
                    $this->connection->commit();
                    $this->logger->debug("Execute commit.");
                } else {
                    $this->logger->warn("Not executed commit because the transaction is not started.");
                }
            } else {
                throw new DatabaseException("Can't execute commit.");
            }
        } catch (\Exception $e) {
            $this->query = null;
            throw new DatabaseException($e);
        }
    }

    /**
     * ロールバックする
     */
    public function rollback()
    {
        try {
            if ($this->connection !== null) {
                if ($this->inTransaction()) {
                    $this->connection->rollback();
                    $this->logger->debug("Execute rollback.");
                } else {
                    $this->logger->warn("Not executed rollback because the transaction is not started.");
                }
            } else {
                throw new DatabaseException("Can't execute rollback.");
            }
        } catch (\Exception $e) {
            $this->query = null;
            throw new DatabaseException($e);
        }
    }

    /**
     * トランザクションスコープを使用する
     * @param  Closure $closure クロージャ

     * @return object 処理結果
     */
    public function transactional(\Closure $closure, $config = [])
    {
        if (!array_key_exists('isolationLevel', $config)) {
            $config['isolationLevel'] = TransactionIsolationLevel::READ_COMMITTED;
        }
        if (!array_key_exists('autoCommit', $config)) {
            $config['autoCommit'] = false;
        }

        $this->isAutoCommit = $config['autoCommit'];
        $this->beginTransaction($config['isolationLevel']);
        try {
            $result = $closure($this);
            $this->commit();
            return $result;
        } catch (DatabaseException $e) {
            $this->rollback();
            throw $e;
        } catch (\Throwable $e) {
            $this->rollback();
            throw new DatabaseException($e);
        }
    }

    /**
     * 自動コミットを有効化
     */
    public function enableAutoCommit()
    {
        $this->isAutoCommit = true;
    }

    /**
     * 自動コミットを無効化
     */
    public function disableAutoCommit()
    {
        $this->isAutoCommit = false;
    }

    /**
     * ロールバックが発生したかどうか
     * @return boolean ロールバックが発生したかどうか
     */
    public function isRollback()
    {
        return $this->isRollback;
    }

    /**
     * トランザクション内かどうか
     * @return boolean トランザクション内かどうか
     */
    public function inTransaction()
    {
        return $this->connection->inTransaction();
    }

    /**
     * DB接続されているか
     * @param boolean 接続有無

     */
    public function isConnected()
    {
        return $this->connection->isConnected();
    }

    /**
     * トランザクション分離レベルを返却する
     * @return int トランザクション分離レベル
     */
    public function getTransactionIsolation()
    {
        return $this->connection->getTransactionIsolation();
    }

    /**
     * データベース接続が可能かどうか
     * @param string Modelファイルパス

     * @return boolean 接続可否
     */
    public function loadConnection($filepath)
    {
        $connection = $this->connectionManager->getConnection($filepath);
        if ($connection !== null) {
            $this->connection = $connection;
        }

        return $this->connection !== null;
    }

    /**
     * クエリを設定する
     * @param string SQL
     * @param array<string> パラメータ

     */
    public function query($sql, array $bind = [])
    {
        if ($this->query === null) {
            throw new DatabaseException("Query does not set because database connection failed.");
        }
        $this->query->setSql($sql);
        $this->query->setBind($bind);

        return $this->query;
    }
}


1		<?php
2
3		namespace WebStream\Database;
4
5		use WebStream\DI\Injector;
		0 ignored issues – show Bug introduced 2017-11-05 13:52 UTC by Report Bug Copy Issue Report The type `WebStream\DI\Injector` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6		use WebStream\Container\Container;
		0 ignored issues – show Bug introduced 2017-11-05 13:52 UTC by Report Bug Copy Issue Report The type `WebStream\Container\Container` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7		use WebStream\Exception\Extend\DatabaseException;
		0 ignored issues – show Bug introduced 2017-11-05 13:48 UTC by Report Bug Copy Issue Report The type `WebStream\Exception\Extend\DatabaseException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8		use WebStream\Database\Driver\DatabaseDriver;
9		use Doctrine\DBAL\TransactionIsolationLevel;
10
11		/**
12		* DatabaseManager
13		* @author Ryuichi TANAKA.
14		* @since 2013/12/07
15		* @version 0.4
16		*/
17		class DatabaseManager
18		{
19		use Injector;
20
21		/**
22		* @var ConnectionManager コネクションマネージャ
23		*/
24		private $connectionManager;
25
26		/**
27		* @var DatabaseDriver データベースコネクション
28		*/
29		private $connection;
30
31		/**
32		* @var bool 自動コミットフラグ
33		*/
34		private $isAutoCommit;
35
36		/**
37		* @var Query クエリオブジェクト
38		*/
39		private $query;
40
41		/**
42		* @var Logger ロガー
		0 ignored issues – show Bug introduced 2017-11-05 13:48 UTC by Report Bug Copy Issue Report The type `WebStream\Database\Logger` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
43		*/
44		private $logger;
45
46		/**
47		* constructor
48		* @param Container 依存コンテナ
		0 ignored issues – show Documentation Bug introduced 2020-08-02 14:29 UTC by Report Bug Copy Issue Report The doc comment `依存コンテナ` at position `0` could not be parsed: Unknown type name '依存コンテナ' at position 0 in 依存コンテナ. Loading history...
49		*/
50	52	public function __construct(Container $container)
51		{
52	52	$this->connectionManager = new ConnectionManager($container);
53	52	$this->logger = $container->logger;
54	52	$this->isAutoCommit = false;
55	52	}
56
57		/**
58		* destructor
59		*/
60	52	public function __destruct()
61		{
62	52	$this->disconnect();
63	52	$this->query = null;
64	52	}
65
66		/**
67		* データベース接続する
68		* すでに接続中であれば再接続はしない
69		*/
70	52	public function connect()
71		{
72		try {
73	52	$this->connection->connect();
74	52	$this->query = new Query($this->connection);
75	52	$this->query->inject('logger', $this->logger);
76		} catch (\PDOException $e) {
77		throw new DatabaseException($e);
78		}
79	52	}
80
81		/**
82		* データベース切断する
83		*/
84	52	public function disconnect()
85		{
86	52	if ($this->connection === null) {
87	52	return;
88		}
89
90	52	if ($this->inTransaction()) {
91		// トランザクションが明示的に開始された状態でcommit/rollbackが行われていない場合
92		// ログに警告を書き込み、強制的にロールバックする
93	16	$this->connection->rollback();
94	16	$this->logger->warn("Not has been executed commit or rollback after the transaction started.");
95		}
96
97	52	$this->connection->disconnect();
98	52	$this->connection = null;
99	52	}
100
101		/**
102		* トランザクションを開始する
103		* @param int $isolationLevel トランザクション分離レベル
104		*/
105	16	public function beginTransaction(int $isolationLevel)
106		{
107		// 既にトランザクションが開始されている場合、継続しているトランザクションを有効のままにする
108		// トランザクションを破棄して再度開始する場合は明示的に破棄してから再呼び出しする
109	16	if ($this->inTransaction()) {
110		$this->logger->debug("Transaction already started.");
111
112		return;
113		}
114
115	16	if (!$this->connection->beginTransaction()) {
116		throw new DatabaseException("Failed to start transaction.");
117		}
118
119	16	$this->connection->setAutoCommit($this->isAutoCommit);
120
121		if (
122	16	$isolationLevel === TransactionIsolationLevel::READ_UNCOMMITTED \|\|
123	16	$isolationLevel === TransactionIsolationLevel::READ_COMMITTED \|\|
124		$isolationLevel === TransactionIsolationLevel::REPEATABLE_READ \|\|
125	16	$isolationLevel === TransactionIsolationLevel::SERIALIZABLE
126		) {
127	16	$this->connection->setTransactionIsolation($isolationLevel);
128		} else {
129		throw new DatabaseException("Invalid transaction isolation level: " . $isolationLevel);
130		}
131
132	16	$this->logger->debug("Transaction start.");
133	16	}
134
135		/**
136		* コミットする
137		*/
138	8	public function commit()
139		{
140		try {
141	8	if ($this->connection !== null) {
142	8	if ($this->inTransaction()) {
143	8	$this->connection->commit();
144	8	$this->logger->debug("Execute commit.");
145		} else {
146	8	$this->logger->warn("Not executed commit because the transaction is not started.");
147		}
148		} else {
149	8	throw new DatabaseException("Can't execute commit.");
150		}
151		} catch (\Exception $e) {
152		$this->query = null;
153		throw new DatabaseException($e);
154		}
155	8	}
156
157		/**
158		* ロールバックする
159		*/
160	8	public function rollback()
161		{
162		try {
163	8	if ($this->connection !== null) {
164	8	if ($this->inTransaction()) {
165	8	$this->connection->rollback();
166	8	$this->logger->debug("Execute rollback.");
167		} else {
168	8	$this->logger->warn("Not executed rollback because the transaction is not started.");
169		}
170		} else {
171	8	throw new DatabaseException("Can't execute rollback.");
172		}
173		} catch (\Exception $e) {
174		$this->query = null;
175		throw new DatabaseException($e);
176		}
177	8	}
178
179		/**
180		* トランザクションスコープを使用する
181		* @param Closure $closure クロージャ
		0 ignored issues – show Bug introduced 2018-01-03 02:00 UTC by Report Bug Copy Issue Report The type `WebStream\Database\Closure` was not found. Did you mean `Closure`? If so, make sure to prefix the type with `\`. Loading history...
182		* @return object 処理結果
183		*/
184	8	public function transactional(\Closure $closure, $config = [])
185		{
186	8	if (!array_key_exists('isolationLevel', $config)) {
187	4	$config['isolationLevel'] = TransactionIsolationLevel::READ_COMMITTED;
188		}
189	8	if (!array_key_exists('autoCommit', $config)) {
190	4	$config['autoCommit'] = false;
191		}
192
193	8	$this->isAutoCommit = $config['autoCommit'];
194	8	$this->beginTransaction($config['isolationLevel']);
195		try {
196	8	$result = $closure($this);
197	4	$this->commit();
198	4	return $result;
199	4	} catch (DatabaseException $e) {
200		$this->rollback();
201		throw $e;
202	4	} catch (\Throwable $e) {
203	4	$this->rollback();
204	4	throw new DatabaseException($e);
205		}
206		}
207
208		/**
209		* 自動コミットを有効化
210		*/
211	16	public function enableAutoCommit()
212		{
213	16	$this->isAutoCommit = true;
214	16	}
215
216		/**
217		* 自動コミットを無効化
218		*/
219	4	public function disableAutoCommit()
220		{
221	4	$this->isAutoCommit = false;
222	4	}
223
224		/**
225		* ロールバックが発生したかどうか
226		* @return boolean ロールバックが発生したかどうか
227		*/
228		public function isRollback()
229		{
230		return $this->isRollback;
231		}
232
233		/**
234		* トランザクション内かどうか
235		* @return boolean トランザクション内かどうか
236		*/
237	52	public function inTransaction()
238		{
239	52	return $this->connection->inTransaction();
240		}
241
242		/**
243		* DB接続されているか
244		* @param boolean 接続有無
		0 ignored issues – show Documentation Bug introduced 2020-08-02 14:29 UTC by Report Bug Copy Issue Report The doc comment `接続有無` at position `0` could not be parsed: Unknown type name '接続有無' at position 0 in 接続有無. Loading history...
245		*/
246		public function isConnected()
247		{
248		return $this->connection->isConnected();
249		}
250
251		/**
252		* トランザクション分離レベルを返却する
253		* @return int トランザクション分離レベル
254		*/
255		public function getTransactionIsolation()
256		{
257		return $this->connection->getTransactionIsolation();
258		}
259
260		/**
261		* データベース接続が可能かどうか
262		* @param string Modelファイルパス
		0 ignored issues – show Documentation Bug introduced 2020-08-02 14:29 UTC by Report Bug Copy Issue Report The doc comment `Modelファイルパス` at position `0` could not be parsed: Unknown type name 'Modelファイルパス' at position 0 in Modelファイルパス. Loading history...
263		* @return boolean 接続可否
264		*/
265	52	public function loadConnection($filepath)
266		{
267	52	$connection = $this->connectionManager->getConnection($filepath);
268	52	if ($connection !== null) {
269	52	$this->connection = $connection;
270		}
271
272	52	return $this->connection !== null;
273		}
274
275		/**
276		* クエリを設定する
277		* @param string SQL
278		* @param array<string> パラメータ
		0 ignored issues – show Documentation Bug introduced 2020-08-02 14:29 UTC by Report Bug Copy Issue Report The doc comment `パラメータ` at position `0` could not be parsed: Unknown type name 'パラメータ' at position 0 in パラメータ. Loading history...
279		*/
280	52	public function query($sql, array $bind = [])
281		{
282	52	if ($this->query === null) {
283		throw new DatabaseException("Query does not set because database connection failed.");
284		}
285	52	$this->query->setSql($sql);
286	52	$this->query->setBind($bind);
287
288	52	return $this->query;
289		}
290		}
291

webstream-framework / Database

Push — master ( 76b08e...5cd6b2 )

DatabaseManager::getTransactionIsolation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like