ActiveRecordModel - Code Metrics - Inspection of "Added method to execute rawsql with params" - canax/database - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5)

unknown

created 2017-10-11 19:38 UTC

ActiveRecordModel A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	221
Duplicated Lines	12.67 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

65.38%

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	2
dl	28
loc	221
ccs	51
cts	78
cp	0.6538
rs	10
c	0
b	0
f	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	setDb()	0	4	1
A	checkDb()	0	6	2
A	getProperties()	0	8	1
A	find()	0	10	1
A	findAll()	0	9	1
A	findAllWhere()	0	11	2
A	findAllSql()	0	7	1
A	save()	0	8	2
A	create()	14	14	1
A	update()	14	14	1
A	delete()	0	12	2

How to fix Duplicated Code

<?php

namespace Anax\Database;

use \Anax\Database\DatabaseQueryBuilder;
use \Anax\Database\Exception\ActiveRecordException;

/**
 * An implementation of the Active Record pattern to be used as
 * base class for database driven models.
 */
class ActiveRecordModel
{
    /**
     * @var DatabaseQueryBuilder $db the object for persistent
     *                               storage.
     */
    protected $db = null;

    /**
     * @var string $tableName name of the database table.
     */
    protected $tableName = null;



    /**
     * Set the database object to use for accessing storage.
     *
     * @param DatabaseQueryBuilder $db as database access object.
     *
     * @return void
     */
    public function setDb(DatabaseQueryBuilder $db)
    {
        $this->db = $db;
    }



    /**
     * Check if database is injected or throw an exception.
     *
     * @throws ActiveRecordException when database is not set.
     *
     * @return void
     */
    protected function checkDb()
    {
        if (!$this->db) {
            throw new ActiveRecordException("Missing \$db, did you forget to inject/set is?");
        }
    }



    /**
     * Get essential object properties.
     *
     * @return array with object properties.
     */
    protected function getProperties()
    {
        $properties = get_object_vars($this);
        unset($properties['tableName']);
        unset($properties['db']);
        unset($properties['di']);
        return $properties;
    }



    /**
     * Find and return first object found by search criteria and use
     * its data to populate this instance.
     *
     * @param string $column to use in where statement.
     * @param mixed  $value  to use in where statement.
     *
     * @return this
     */
    public function find($column, $value)
    {
        $this->checkDb();
        return $this->db->connect()
                        ->select()
                        ->from($this->tableName)
                        ->where("$column = ?")
                        ->execute([$value])
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        ->fetchInto($this);
    }



    /**
     * Find and return all.
     *
     * @return array of object of this class
     */
    public function findAll()
    {
        $this->checkDb();
        return $this->db->connect()
                        ->select()
                        ->from($this->tableName)
                        ->execute()
                        ->fetchAllClass(get_class($this));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }



    /**
     * Find and return all matching a search criteria of
     * for example `id = ?` or `id IN [?, ?]`.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return array of object of this class
     */
    public function findAllWhere($where, $value)
    {
        $this->checkDb();
        $params = is_array($value) ? $value : [$value];
        return $this->db->connect()
                        ->select()
                        ->from($this->tableName)
                        ->where($where)
                        ->execute($params)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        ->fetchAllClass(get_class($this));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }



    /**
     * Execute rawsql
     * @param string $sql rawsql
     * @param array $params params
     *
     * @return array
     */
    public function findAllSql($sql, $params)
    {
        $this->checkDb();
        return $this->db->connect()
                        ->execute($sql, $params)
                        ->fetchAllClass(get_class($this));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }



    /**
     * Save current object/row, insert if id is missing and do an
     * update if the id exists.
     *
     * @return void
     */
    public function save()
    {
        if (isset($this->id)) {
            return $this->update();
        }

        return $this->create();
    }



    /**
     * Create new row.
     *
     * @return void
     */
    protected function create()

    {
        $this->checkDb();
        $properties = $this->getProperties();
        unset($properties['id']);
        $columns = array_keys($properties);
        $values  = array_values($properties);

        $this->db->connect()
                 ->insert($this->tableName, $columns)
                 ->execute($values);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->id = $this->db->lastInsertId();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }



    /**
     * Update row.
     *
     * @return void
     */
    protected function update()

    {
        $this->checkDb();
        $properties = $this->getProperties();
        unset($properties['id']);
        $columns = array_keys($properties);
        $values  = array_values($properties);
        $values[] = $this->id;

        $this->db->connect()
                 ->update($this->tableName, $columns)
                 ->where("id = ?")
                 ->execute($values);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }



    /**
     * Delete row.
     *
     * @param integer $id to delete or use $this->id as default.
     *
     * @return void
     */
    public function delete($id = null)
    {
        $this->checkDb();
        $id = $id ?: $this->id;

        $this->db->connect()
                 ->deleteFrom($this->tableName)
                 ->where("id = ?")
                 ->execute([$id]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->id = null;
    }
}


1			<?php
2
3			namespace Anax\Database;
4
5			use \Anax\Database\DatabaseQueryBuilder;
6			use \Anax\Database\Exception\ActiveRecordException;
7
8			/**
9			* An implementation of the Active Record pattern to be used as
10			* base class for database driven models.
11			*/
12			class ActiveRecordModel
13			{
14			/**
15			* @var DatabaseQueryBuilder $db the object for persistent
16			* storage.
17			*/
18			protected $db = null;
19
20			/**
21			* @var string $tableName name of the database table.
22			*/
23			protected $tableName = null;
24
25
26
27			/**
28			* Set the database object to use for accessing storage.
29			*
30			* @param DatabaseQueryBuilder $db as database access object.
31			*
32			* @return void
33			*/
34	3		public function setDb(DatabaseQueryBuilder $db)
35			{
36	3		$this->db = $db;
37	3		}
38
39
40
41			/**
42			* Check if database is injected or throw an exception.
43			*
44			* @throws ActiveRecordException when database is not set.
45			*
46			* @return void
47			*/
48	4		protected function checkDb()
49			{
50	4		if (!$this->db) {
51	1		throw new ActiveRecordException("Missing \$db, did you forget to inject/set is?");
52			}
53	3		}
54
55
56
57			/**
58			* Get essential object properties.
59			*
60			* @return array with object properties.
61			*/
62	3		protected function getProperties()
63			{
64	3		$properties = get_object_vars($this);
65	3		unset($properties['tableName']);
66	3		unset($properties['db']);
67	3		unset($properties['di']);
68	3		return $properties;
69			}
70
71
72
73			/**
74			* Find and return first object found by search criteria and use
75			* its data to populate this instance.
76			*
77			* @param string $column to use in where statement.
78			* @param mixed $value to use in where statement.
79			*
80			* @return this
81			*/
82	1		public function find($column, $value)
83			{
84	1		$this->checkDb();
85	1		return $this->db->connect()
86	1		->select()
87	1		->from($this->tableName)
88	1		->where("$column = ?")
89	1		->execute([$value])
			0 ignored issues – show Documentation introduced 2017-09-05 11:11 UTC by Report Bug Copy Issue Report `array($value)` is of type `array<integer,,{"0":""}>`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90	1		->fetchInto($this);
91			}
92
93
94
95			/**
96			* Find and return all.
97			*
98			* @return array of object of this class
99			*/
100	1		public function findAll()
101			{
102	1		$this->checkDb();
103	1		return $this->db->connect()
104	1		->select()
105	1		->from($this->tableName)
106	1		->execute()
107	1		->fetchAllClass(get_class($this));
			0 ignored issues – show Documentation introduced 2017-09-05 11:11 UTC by Report Bug Copy Issue Report `get_class($this)` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
108			}
109
110
111
112			/**
113			* Find and return all matching a search criteria of
114			* for example `id = ?` or `id IN [?, ?]`.
115			*
116			* @param string $where to use in where statement.
117			* @param mixed $value to use in where statement.
118			*
119			* @return array of object of this class
120			*/
121	1		public function findAllWhere($where, $value)
122			{
123	1		$this->checkDb();
124	1		$params = is_array($value) ? $value : [$value];
125	1		return $this->db->connect()
126	1		->select()
127	1		->from($this->tableName)
128	1		->where($where)
129	1		->execute($params)
			0 ignored issues – show Documentation introduced 2017-10-09 07:45 UTC by Report Bug Copy Issue Report `$params` is of type `array`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
130	1		->fetchAllClass(get_class($this));
			0 ignored issues – show Documentation introduced 2017-10-09 07:45 UTC by Report Bug Copy Issue Report `get_class($this)` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
131			}
132
133
134
135			/**
136			* Execute rawsql
137			* @param string $sql rawsql
138			* @param array $params params
139			*
140			* @return array
141			*/
142			public function findAllSql($sql, $params)
143			{
144			$this->checkDb();
145			return $this->db->connect()
146			->execute($sql, $params)
147			->fetchAllClass(get_class($this));
			0 ignored issues – show Documentation introduced 2017-10-11 19:39 UTC by Report Bug Copy Issue Report `get_class($this)` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
148			}
149
150
151
152			/**
153			* Save current object/row, insert if id is missing and do an
154			* update if the id exists.
155			*
156			* @return void
157			*/
158	4		public function save()
159			{
160	4		if (isset($this->id)) {
161			return $this->update();
162			}
163
164	4		return $this->create();
165			}
166
167
168
169			/**
170			* Create new row.
171			*
172			* @return void
173			*/
174	4	View Code Duplication	protected function create()
			0 ignored issues – show Duplication introduced 2017-08-30 06:06 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...
175			{
176	4		$this->checkDb();
177	3		$properties = $this->getProperties();
178	3		unset($properties['id']);
179	3		$columns = array_keys($properties);
180	3		$values = array_values($properties);
181
182	3		$this->db->connect()
183	3		->insert($this->tableName, $columns)
184	3		->execute($values);
			0 ignored issues – show Documentation introduced 2017-09-05 11:11 UTC by Report Bug Copy Issue Report `$values` is of type `array<integer,?>`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
185
186	3		$this->id = $this->db->lastInsertId();
			0 ignored issues – show Bug introduced 2017-08-30 06:06 UTC by Report Bug Copy Issue Report The property `id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
187	3		}
188
189
190
191			/**
192			* Update row.
193			*
194			* @return void
195			*/
196		View Code Duplication	protected function update()
			0 ignored issues – show Duplication introduced 2017-09-05 11:11 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...
197			{
198			$this->checkDb();
199			$properties = $this->getProperties();
200			unset($properties['id']);
201			$columns = array_keys($properties);
202			$values = array_values($properties);
203			$values[] = $this->id;
204
205			$this->db->connect()
206			->update($this->tableName, $columns)
207			->where("id = ?")
208			->execute($values);
			0 ignored issues – show Documentation introduced 2017-09-05 11:11 UTC by Report Bug Copy Issue Report `$values` is of type `array<integer,?>`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
209			}
210
211
212
213			/**
214			* Delete row.
215			*
216			* @param integer $id to delete or use $this->id as default.
217			*
218			* @return void
219			*/
220			public function delete($id = null)
221			{
222			$this->checkDb();
223			$id = $id ?: $this->id;
224
225			$this->db->connect()
226			->deleteFrom($this->tableName)
227			->where("id = ?")
228			->execute([$id]);
			0 ignored issues – show Documentation introduced 2017-09-05 11:11 UTC by Report Bug Copy Issue Report `array($id)` is of type `array<integer,?,{"0":"?"}>`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
229
230			$this->id = null;
231			}
232			}
233

canax / database

Pull Request — master (#5)

ActiveRecordModel A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like