Entity - Code Metrics - andela-aonyango/potato-orm - Measure and Improve Code Quality continuously with Scrutinizer

Entity A
last analyzed 2016-02-26 12:31 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
wmc	11
c	3
b	0
f	0
lcom	1
cbo	1
dl	0
loc	84
rs	10

6 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	add()	8	2
A	update()	16	4
A	remove()	10	2
A	find()	6	1
A	findAll()	6	1

<?php
/**
 * @file     Entity.php
 * This class is a model that can be inherited by other classes
 * and used to persist and retrieve objects from a database
 * @package  PotatoORM
 * @author   andrew <[email protected]>
 * @license  MIT => https://opensource.org/licenses/MIT
 */

namespace PotatoORM;

/**
 * @category Class
 * @package  PotatoORM
 */
class Entity
{
    private $db;

    /**
     * Instantiates a Database object
     */
    public function __construct()
    {
        $this->db = new Database();
    }

    /**
     * Adds a record to the database and returns the last inserted ID
     * @return int
     */
    public function add()
    {
        foreach ($this->db_fields as $key) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $data[$key] = $this->$key;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        return $this->db->insert($this->entity_table, $data);
class MyClass { }

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

    /**
     * Updates an existing record in the database
     */
    public function update()
    {
        foreach ($this->db_fields as $key) {
            if (!is_null($this->$key)) {
                $data[$key] = $this->$key;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            }
        }

        $where = "";
        foreach ($this->primary_keys as $key) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $where .= " $key = " . $this->$key . " &&";
        }

        $where = rtrim($where, "&");
        $this->db->update($this->entity_table, $data, $where);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Deletes a record from the database
     * @return int
     */
    public function remove()
    {
        $where = "";
        foreach ($this->primary_keys as $key) {
            $where .= " $key = " . $this->$key . " &&";
        }

        $where = rtrim($where, "&");
        $this->db->delete($this->entity_table, $where);
    }

    /**
     * Retrieves a record from the database based on its ID
     * and returns it in the form of the corresponding object
     * @return object
     */
    public function find($id)
    {
        $this->db->select($this->entity_table, " id = $id");

        return $this->db->singleObject(get_called_class());
    }

    /**
     * Retrieves all records from the corresponding table in the
     * database and returns them as an array of objects
     * @return array
     */
    public function findAll()
    {
        $this->db->select($this->entity_table);

        return $this->db->objectSet(get_called_class());
    }
}


1			<?php
2			/**
3			* @file Entity.php
4			* This class is a model that can be inherited by other classes
5			* and used to persist and retrieve objects from a database
6			* @package PotatoORM
7			* @author andrew <[email protected]>
8			* @license MIT => https://opensource.org/licenses/MIT
9			*/
10
11			namespace PotatoORM;
12
13			/**
14			* @category Class
15			* @package PotatoORM
16			*/
17			class Entity
18			{
19			private $db;
20
21			/**
22			* Instantiates a Database object
23			*/
24			public function __construct()
25			{
26			$this->db = new Database();
27			}
28
29			/**
30			* Adds a record to the database and returns the last inserted ID
31			* @return int
32			*/
33			public function add()
34			{
35			foreach ($this->db_fields as $key) {
			0 ignored issues – show Bug introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report The property `db_fields` 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...
36			$data[$key] = $this->$key;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
37			}
38
39			return $this->db->insert($this->entity_table, $data);
			0 ignored issues – show Bug introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report The property `entity_table` 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... Bug introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
40			}
41
42			/**
43			* Updates an existing record in the database
44			*/
45			public function update()
46			{
47			foreach ($this->db_fields as $key) {
48			if (!is_null($this->$key)) {
49			$data[$key] = $this->$key;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
50			}
51			}
52
53			$where = "";
54			foreach ($this->primary_keys as $key) {
			0 ignored issues – show Bug introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report The property `primary_keys` 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...
55			$where .= " $key = " . $this->$key . " &&";
56			}
57
58			$where = rtrim($where, "&");
59			$this->db->update($this->entity_table, $data, $where);
			0 ignored issues – show Bug introduced 2016-02-19 09:30 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
60			}
61
62			/**
63			* Deletes a record from the database
64			* @return int
65			*/
66			public function remove()
67			{
68			$where = "";
69			foreach ($this->primary_keys as $key) {
70			$where .= " $key = " . $this->$key . " &&";
71			}
72
73			$where = rtrim($where, "&");
74			$this->db->delete($this->entity_table, $where);
75			}
76
77			/**
78			* Retrieves a record from the database based on its ID
79			* and returns it in the form of the corresponding object
80			* @return object
81			*/
82			public function find($id)
83			{
84			$this->db->select($this->entity_table, " id = $id");
85
86			return $this->db->singleObject(get_called_class());
87			}
88
89			/**
90			* Retrieves all records from the corresponding table in the
91			* database and returns them as an array of objects
92			* @return array
93			*/
94			public function findAll()
95			{
96			$this->db->select($this->entity_table);
97
98			return $this->db->objectSet(get_called_class());
99			}
100			}
101

andela-aonyango / potato-orm

Entity A last analyzed 2016-02-26 12:31 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Entity A
last analyzed 2016-02-26 12:31 UTC