Pdo - Code Metrics - Inspection of "Abandon all ships" - Logi-CE/fmup - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 231a12...f06e64 )

by Jay

created 2017-10-12 09:53 UTC

Pdo A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	205
Duplicated Lines	27.8 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

89.61%

Importance

Changes

Metric	Value
dl	57
loc	205
ccs	69
cts	77
cp	0.8961
rs	10
c	0
b	0
f	0
wmc	27
lcom	1
cbo	2

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getCharset()	0	5	2
A	defaultConfiguration()	0	9	1
A	fetchAll()	14	14	3
A	beginTransaction()	0	14	3
A	rollback()	10	10	2
A	errorCode()	0	9	2
A	errorInfo()	0	9	2
A	commit()	10	10	2
A	execute()	0	15	3
A	prepare()	0	10	2
A	lastInsertId()	9	9	2
A	count()	14	14	3

How to fix Duplicated Code

<?php

namespace FMUP\Db\Driver;

use FMUP\Db\Exception;
use FMUP\Logger;

class Pdo extends PdoConfiguration
{
    const CHARSET_UTF8 = 'utf8';

    /**
     * Charset to use
     * @return string
     */
    protected function getCharset()
    {
        $charset = (string)$this->getSettings('charset');
        return $charset ?: self::CHARSET_UTF8;
    }

    /**
     * @param \Pdo $instance
     * @return $this
     */
    protected function defaultConfiguration(\Pdo $instance)
    {
        $charset = $this->getCharset();
        $instance->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
        $instance->setAttribute(\PDO::ATTR_TIMEOUT, 10.0);
        $instance->exec('SET NAMES ' . $charset);
        $instance->exec('SET CHARACTER SET ' . $charset);
        return $this;
    }

    /**
     * Fetch all rows for a given statement
     * @param object $statement
     * @return array
     * @throws Exception
     */
    public function fetchAll($statement)

    {
        if (!$statement instanceof \PDOStatement) {
            $this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
            throw new Exception('Statement not in right format');
        }

        try {
            return $statement->fetchAll($this->getFetchMode());
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Begin a transaction
     * @return bool
     * @throws Exception
     */
    public function beginTransaction()
    {
        try {
            if ($this->getDriver()->inTransaction()) {
                $this->log(Logger::CRITICAL, 'Transaction already opened', $this->getSettings());

                throw new Exception('Transaction already opened');
            }
            $this->log(Logger::DEBUG, 'Transaction start');
            return $this->getDriver()->beginTransaction();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('settings' => $this->getSettings()));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * @return bool
     * @throws Exception
     */
    public function rollback()

    {
        try {
            $this->log(Logger::DEBUG, 'Transaction rollback');
            return $this->getDriver()->rollBack();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * @return mixed
     * @throws Exception
     */
    public function errorCode()
    {
        try {
            return $this->getDriver()->errorCode();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * @return array
     * @throws Exception
     */
    public function errorInfo()
    {
        try {
            return $this->getDriver()->errorInfo();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * @return bool
     * @throws Exception
     */
    public function commit()

    {
        try {
            $this->log(Logger::DEBUG, 'Transaction commit');
            return $this->getDriver()->commit();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Execute a statement for given values
     * @param object $statement
     * @param array $values
     * @return bool
     * @throws Exception
     */
    public function execute($statement, $values = array())
    {
        if (!$statement instanceof \PDOStatement) {
            $this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
            throw new Exception('Statement not in right format');
        }

        try {
            $this->log(Logger::DEBUG, 'Executing query', array('values' => $values));
            return $statement->execute($values);
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('exception' => $e, 'values' => $values));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Prepare a SQL string to a statement
     * @param string $sql
     * @param array $options
     * @return \PDOStatement
     * @throws Exception
     */
    public function prepare($sql, array $options = array())
    {
        try {
            $this->log(Logger::DEBUG, 'Preparing query', array('sql' => $sql, 'options' => $options));
            return $this->getDriver()->prepare($sql, $options);
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('exception' => $e, 'sql' => $sql));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Retrieve id inserted
     * @param string $name optional
     * @return string
     * @throws Exception
     */
    public function lastInsertId($name = null)

    {
        try {
            return $this->getDriver()->lastInsertId($name);
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Retrieve number of affected rows of a statement
     * @param mixed $statement
     * @return int
     * @throws Exception
     */
    public function count($statement)

    {
        if (!$statement instanceof \PDOStatement) {
            $this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
            throw new Exception('Statement not in right format');
        }

        try {
            return $statement->rowCount();
        } catch (\PDOException $e) {
            $this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
            throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
        }
    }
}


1			<?php
2
3			namespace FMUP\Db\Driver;
4
5			use FMUP\Db\Exception;
6			use FMUP\Logger;
7
8			class Pdo extends PdoConfiguration
9			{
10			const CHARSET_UTF8 = 'utf8';
11
12			/**
13			* Charset to use
14			* @return string
15			*/
16	2		protected function getCharset()
17			{
18	2		$charset = (string)$this->getSettings('charset');
19	2		return $charset ?: self::CHARSET_UTF8;
20			}
21
22			/**
23			* @param \Pdo $instance
24			* @return $this
25			*/
26	1		protected function defaultConfiguration(\Pdo $instance)
27			{
28	1		$charset = $this->getCharset();
29	1		$instance->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
30	1		$instance->setAttribute(\PDO::ATTR_TIMEOUT, 10.0);
31	1		$instance->exec('SET NAMES ' . $charset);
32	1		$instance->exec('SET CHARACTER SET ' . $charset);
33	1		return $this;
34			}
35
36			/**
37			* Fetch all rows for a given statement
38			* @param object $statement
39			* @return array
40			* @throws Exception
41			*/
42	3	View Code Duplication	public function fetchAll($statement)
			0 ignored issues – show Duplication introduced 2017-08-25 13:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
43			{
44	3		if (!$statement instanceof \PDOStatement) {
45	1		$this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
46	1		throw new Exception('Statement not in right format');
47			}
48
49			try {
50	2		return $statement->fetchAll($this->getFetchMode());
51	1		} catch (\PDOException $e) {
52	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
53	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
54			}
55			}
56
57			/**
58			* Begin a transaction
59			* @return bool
60			* @throws Exception
61			*/
62	3		public function beginTransaction()
63			{
64			try {
65	3		if ($this->getDriver()->inTransaction()) {
66	1		$this->log(Logger::CRITICAL, 'Transaction already opened', $this->getSettings());
			0 ignored issues – show Bug introduced 2017-04-18 14:53 UTC by Report Bug Copy Issue Report It seems like `$this->getSettings()` targeting `FMUP\Db\Driver\PdoConfiguration::getSettings()` can also be of type `null`; however, `FMUP\Logger\LoggerTrait::log()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
67	1		throw new Exception('Transaction already opened');
68			}
69	1		$this->log(Logger::DEBUG, 'Transaction start');
70	1		return $this->getDriver()->beginTransaction();
71	2		} catch (\PDOException $e) {
72	1		$this->log(Logger::ERROR, $e->getMessage(), array('settings' => $this->getSettings()));
73	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
74			}
75			}
76
77			/**
78			* @return bool
79			* @throws Exception
80			*/
81	2	View Code Duplication	public function rollback()
			0 ignored issues – show Duplication introduced 2017-10-11 16:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
82			{
83			try {
84	2		$this->log(Logger::DEBUG, 'Transaction rollback');
85	2		return $this->getDriver()->rollBack();
86	1		} catch (\PDOException $e) {
87	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
88	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
89			}
90			}
91
92			/**
93			* @return mixed
94			* @throws Exception
95			*/
96	2		public function errorCode()
97			{
98			try {
99	2		return $this->getDriver()->errorCode();
100	1		} catch (\PDOException $e) {
101	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
102	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
103			}
104			}
105
106			/**
107			* @return array
108			* @throws Exception
109			*/
110	2		public function errorInfo()
111			{
112			try {
113	2		return $this->getDriver()->errorInfo();
114	1		} catch (\PDOException $e) {
115	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
116	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
117			}
118			}
119
120			/**
121			* @return bool
122			* @throws Exception
123			*/
124	2	View Code Duplication	public function commit()
			0 ignored issues – show Duplication introduced 2017-10-11 16:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125			{
126			try {
127	2		$this->log(Logger::DEBUG, 'Transaction commit');
128	2		return $this->getDriver()->commit();
129	1		} catch (\PDOException $e) {
130	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
131	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
132			}
133			}
134
135			/**
136			* Execute a statement for given values
137			* @param object $statement
138			* @param array $values
139			* @return bool
140			* @throws Exception
141			*/
142	3		public function execute($statement, $values = array())
143			{
144	3		if (!$statement instanceof \PDOStatement) {
145	1		$this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
146	1		throw new Exception('Statement not in right format');
147			}
148
149			try {
150	2		$this->log(Logger::DEBUG, 'Executing query', array('values' => $values));
151	2		return $statement->execute($values);
152	1		} catch (\PDOException $e) {
153	1		$this->log(Logger::ERROR, $e->getMessage(), array('exception' => $e, 'values' => $values));
154	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
155			}
156			}
157
158			/**
159			* Prepare a SQL string to a statement
160			* @param string $sql
161			* @param array $options
162			* @return \PDOStatement
163			* @throws Exception
164			*/
165	3		public function prepare($sql, array $options = array())
166			{
167			try {
168	3		$this->log(Logger::DEBUG, 'Preparing query', array('sql' => $sql, 'options' => $options));
169	3		return $this->getDriver()->prepare($sql, $options);
170	1		} catch (\PDOException $e) {
171	1		$this->log(Logger::ERROR, $e->getMessage(), array('exception' => $e, 'sql' => $sql));
172	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
173			}
174			}
175
176			/**
177			* Retrieve id inserted
178			* @param string $name optional
179			* @return string
180			* @throws Exception
181			*/
182	2	View Code Duplication	public function lastInsertId($name = null)
			0 ignored issues – show Duplication introduced 2017-08-25 13:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
183			{
184			try {
185	2		return $this->getDriver()->lastInsertId($name);
186	1		} catch (\PDOException $e) {
187	1		$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
188	1		throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
189			}
190			}
191
192			/**
193			* Retrieve number of affected rows of a statement
194			* @param mixed $statement
195			* @return int
196			* @throws Exception
197			*/
198		View Code Duplication	public function count($statement)
			0 ignored issues – show Duplication introduced 2017-10-11 16:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
199			{
200			if (!$statement instanceof \PDOStatement) {
201			$this->log(Logger::ERROR, 'Statement not in right format', array('statement' => $statement));
202			throw new Exception('Statement not in right format');
203			}
204
205			try {
206			return $statement->rowCount();
207			} catch (\PDOException $e) {
208			$this->log(Logger::ERROR, $e->getMessage(), array('error' => $e));
209			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
210			}
211			}
212			}
213

Logi-CE / fmup

Push — master ( 231a12...f06e64 )

Pdo A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like