Database::getConfigParameters() - Code Metrics - Inspection of "Feature/migration" - suricate-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#30)

by Mathieu

created 2024-01-16 14:16 UTC

Database::getConfigParameters() A

↳ Parent: Database

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Suricate;

use Exception;
use PDO;

/**
 * Database extension for Suricate
 *
 * @package Suricate
 * @author  Mathieu LESNIAK <[email protected]>
 *
 * @property array $configs array of predefined DB configurations
 */

class Database extends Service
{
    use Traits\DatabaseMySQL;
    use Traits\DatabaseSQLite;

    protected $parametersList = ['configs'];

    /** @var string current configuration name */
    private $config;
    private $handler;
    private $statement;

    public function __construct()
    {
        parent::__construct();

        $this->configs = [];
        $this->handler = false;
    }

    public function configure($parameters = [])
    {
        $dbConfs = [];
        foreach ($parameters as $name => $value) {
            if (is_array($value)) {
                $dbConfs[$name] = $value;
            } else {
                $dbConfs['default'][$name] = $value;
            }
        }
        $parameters = ['configs' => $dbConfs];
        parent::configure($parameters);
    }

    /**
     * Set Configurations list
     *
     * @return Database
     */
    public function setConfigs($configs)
    {
        $this->configs = $configs;

        return $this;
    }

    /**
     * Get configurations list
     *
     * @return array
     */
    public function getConfigs(): array
    {
        return $this->configs;
    }

    /**
     * Set current configuration used
     *
     * @param string $config configuration name
     * @return Database
     */
    public function setConfig(string $config): Database
    {
        $this->config = $config;

        return $this;
    }

    /**
     * Get current configuration name used
     *
     * @return string|null
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Return database handler current config parameters
     *
     * @return array
     */
    public function getConfigParameters(): array
    {
        if ($this->config !== null && isset($this->configs[$this->config])) {
            $params = $this->configs[$this->config];
        } else {
            $confs = array_values($this->configs);
            $params = array_shift($confs);
        }

        return $params;
    }

    private function connect()
    {
        if ($this->handler !== false) {
            return;
        }

        $params = $this->getConfigParameters();

        $pdoAttributes = [\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION];
        switch ($params['type']) {
            case 'mysql':
                $this->configurePDOMySQL(
                    $params,
                    $pdoDsn,
                    $pdoUsername,
                    $pdoPassword,
                    $pdoAttributes
                );
                break;
            case 'sqlite':
                $this->configurePDOSQLite(
                    $params,
                    $pdoDsn,
                    $pdoUsername,
                    $pdoPassword
                );
                break;
            default:
                throw new Exception('Unsupported PDO DB handler');
        }

        try {
            $this->handler = new PDO($pdoDsn, $pdoUsername, $pdoPassword);
            foreach ($pdoAttributes as $attributeKey => $attributeValue) {
                $this->handler->setAttribute($attributeKey, $attributeValue);
            }
        } catch (Exception $e) {
            throw new Exception("Cannot connect to database");
        }
    }

    /**
     * Execute a query against database.
     * Create a connection if not already alvailable
     * @param  string $sql        Query
     * @param  array  $parameters Parameters used in query
     * @return Database
     */
    public function query($sql, $parameters = [])
    {
        $this->connect();

        $this->statement = $this->handler->prepare($sql);
        $this->statement->execute($parameters);

        return $this;
    }

    public function fetchAll($mode = PDO::FETCH_ASSOC)
    {
        return $this->statement->fetchAll($mode);
    }

    public function fetch($mode = PDO::FETCH_ASSOC)
    {
        return $this->statement->fetch($mode);
    }

    public function fetchColumn($colNb = 0)
    {
        return $this->statement->fetchColumn($colNb);
    }

    public function fetchObject()
    {
        return $this->statement->fetch(PDO::FETCH_OBJ);
    }

    /**
     * Return the last inserted id
     *
     * @return string
     */
    public function lastInsertId(): string
    {
        return $this->handler->lastInsertId();
    }

    public function beginTransaction()
    {
        return $this->handler->beginTransaction();
    }

    public function commit(): bool
    {
        return $this->handler->commit();
    }

    public function rollback(): bool
    {
        return $this->handler->rollback();
    }

    public function inTransaction(): bool
    {
        return $this->handler->inTransaction();
    }

    public function getColumnCount()
    {
        return $this->statement->columnCount();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Suricate;
6
7		use Exception;
8		use PDO;
9
10		/**
11		* Database extension for Suricate
12		*
13		* @package Suricate
14		* @author Mathieu LESNIAK <[email protected]>
15		*
16		* @property array $configs array of predefined DB configurations
17		*/
18
19		class Database extends Service
20		{
21		use Traits\DatabaseMySQL;
22		use Traits\DatabaseSQLite;
23
24		protected $parametersList = ['configs'];
25
26		/** @var string current configuration name */
27		private $config;
28		private $handler;
29		private $statement;
30
31	32	public function __construct()
32		{
33	32	parent::__construct();
34
35	32	$this->configs = [];
36	32	$this->handler = false;
37	32	}
38
39	29	public function configure($parameters = [])
40		{
41	29	$dbConfs = [];
42	29	foreach ($parameters as $name => $value) {
43	29	if (is_array($value)) {
44		$dbConfs[$name] = $value;
45		} else {
46	29	$dbConfs['default'][$name] = $value;
47		}
48		}
49	29	$parameters = ['configs' => $dbConfs];
50	29	parent::configure($parameters);
51	29	}
52
53		/**
54		* Set Configurations list
55		*
56		* @return Database
57		*/
58	1	public function setConfigs($configs)
59		{
60	1	$this->configs = $configs;
61
62	1	return $this;
63		}
64
65		/**
66		* Get configurations list
67		*
68		* @return array
69		*/
70	1	public function getConfigs(): array
71		{
72	1	return $this->configs;
73		}
74
75		/**
76		* Set current configuration used
77		*
78		* @param string $config configuration name
79		* @return Database
80		*/
81	1	public function setConfig(string $config): Database
82		{
83	1	$this->config = $config;
84
85	1	return $this;
86		}
87
88		/**
89		* Get current configuration name used
90		*
91		* @return string\|null
92		*/
93	2	public function getConfig()
94		{
95	2	return $this->config;
96		}
97
98	23	/**
99		* Return database handler current config parameters
100	23	*
101	7	* @return array
102		*/
103		public function getConfigParameters(): array
104	23	{
105		if ($this->config !== null && isset($this->configs[$this->config])) {
106		$params = $this->configs[$this->config];
107	23	} else {
108	23	$confs = array_values($this->configs);
109		$params = array_shift($confs);
110		}
111	23
112	23	return $params;
113	23	}
114
115		private function connect()
116		{
117		if ($this->handler !== false) {
118		return;
119		}
120
121		$params = $this->getConfigParameters();
122	23
123	22	$pdoAttributes = [\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION];
124	22	switch ($params['type']) {
125		case 'mysql':
126		$this->configurePDOMySQL(
127		$params,
128		$pdoDsn,
129	22	$pdoUsername,
130		$pdoPassword,
131	1	$pdoAttributes
132		);
133		break;
134		case 'sqlite':
135	22	$this->configurePDOSQLite(
136	22	$params,
137	22	$pdoDsn,
138		$pdoUsername,
139		$pdoPassword
140		);
141		break;
142	22	default:
143		throw new Exception('Unsupported PDO DB handler');
144		}
145
146		try {
147		$this->handler = new PDO($pdoDsn, $pdoUsername, $pdoPassword);
148		foreach ($pdoAttributes as $attributeKey => $attributeValue) {
149		$this->handler->setAttribute($attributeKey, $attributeValue);
150		}
151	23	} catch (Exception $e) {
152		throw new Exception("Cannot connect to database");
153	23	}
154		}
155	22
156	22	/**
157		* Execute a query against database.
158	22	* Create a connection if not already alvailable
159		* @param string $sql Query
160		* @param array $parameters Parameters used in query
161	4	* @return Database
162		*/
163	4	public function query($sql, $parameters = [])
164		{
165		$this->connect();
166	13
167		$this->statement = $this->handler->prepare($sql);
168	13	$this->statement->execute($parameters);
169
170		return $this;
171	1	}
172
173	1	public function fetchAll($mode = PDO::FETCH_ASSOC)
174		{
175		return $this->statement->fetchAll($mode);
176	1	}
177
178	1	public function fetch($mode = PDO::FETCH_ASSOC)
179		{
180		return $this->statement->fetch($mode);
181		}
182
183		public function fetchColumn($colNb = 0)
184		{
185		return $this->statement->fetchColumn($colNb);
186	5	}
187
188	5	public function fetchObject()
189		{
190		return $this->statement->fetch(PDO::FETCH_OBJ);
191		}
192
193		/**
194		* Return the last inserted id
195		*
196		* @return string
197		*/
198		public function lastInsertId(): string
199		{
200		return $this->handler->lastInsertId();
201		}
202
203		public function beginTransaction()
204		{
205		return $this->handler->beginTransaction();
206		}
207
208		public function commit(): bool
209		{
210		return $this->handler->commit();
211	1	}
212
213	1	public function rollback(): bool
214		{
215		return $this->handler->rollback();
216		}
217
218		public function inTransaction(): bool
219		{
220		return $this->handler->inTransaction();
221		}
222
223		public function getColumnCount()
224		{
225		return $this->statement->columnCount();
226		}
227		}
228

suricate-php / framework

Pull Request — master (#30)

Database::getConfigParameters() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like