DatabaseTrait - Code Metrics - Inspection of "Add "belongs_to" relationship to models" - rougin/wildfire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Rougin

created 2016-10-14 06:54 UTC

DatabaseTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

80%

Importance

Changes

Metric	Value
wmc	11
lcom	2
cbo	1
dl	0
loc	84
ccs	24
cts	30
cp	0.8
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	setDatabase()	18	2
A	setQuery()	6	1
C	getTableName()	26	8

<?php

namespace Rougin\Wildfire\Traits;

use Rougin\SparkPlug\Instance;

/**
 * Database Trait
 *
 * @package Wildfire
 * @author  Rougin Royce Gutib <[email protected]>
 *
 * @property string $table
 */
trait DatabaseTrait
{
    /**
     * @var \CI_DB
     */
    protected $db;

    /**
     * @var \CI_DB_result
     */
    protected $query;

    /**
     * Parses the table name from Describe class.
     *
     * @param  string|\CI_Model $table
     * @param  boolean          $isForeignKey
     * @return string
     */
    protected function getTableName($table, $isForeignKey = false)
    {
        $tableName = '';

        if ($table instanceof \CI_Model) {
            if (method_exists($table, 'getTableName')) {
                $tableName = $table->getTableName();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            } elseif (property_exists($table, 'table')) {
                // NOTE: To be removed in v1.0.0
                $tableName = $table->table;

            }
        }

        if (! $isForeignKey && $this->table) {
            $tableName = $this->table;
        }

        if (is_string($table)) {
            $tableName = $table;
        }

        $tableName = ucfirst(singular($tableName));
        $array = explode('.', $tableName);

        return isset($array[1]) ? $array[1] : $tableName;
    }

    /**
     * Sets the database class.
     *
     * @param  \CI_DB|null $database
     * @return self
     */
    public function setDatabase($database = null)
    {
        $ci = Instance::create();

        $ci->load->helper('inflector');


        if (empty($database)) {
            $ci->load->database();

            $this->db = $ci->db;


            return $this;
        }

        $this->db = $database;

        return $this;
    }

    /**
     * Sets the query result.
     *
     * @param  \CI_DB_result $query
     * @return self
     */
    public function setQuery($query)
    {
        $this->query = $query;

        return $this;
    }
}


1		<?php
2
3		namespace Rougin\Wildfire\Traits;
4
5		use Rougin\SparkPlug\Instance;
6
7		/**
8		* Database Trait
9		*
10		* @package Wildfire
11		* @author Rougin Royce Gutib <[email protected]>
12		*
13		* @property string $table
14		*/
15		trait DatabaseTrait
16		{
17		/**
18		* @var \CI_DB
19		*/
20		protected $db;
21
22		/**
23		* @var \CI_DB_result
24		*/
25		protected $query;
26
27		/**
28		* Parses the table name from Describe class.
29		*
30		* @param string\|\CI_Model $table
31		* @param boolean $isForeignKey
32		* @return string
33		*/
34	36	protected function getTableName($table, $isForeignKey = false)
35		{
36	36	$tableName = '';
37
38	36	if ($table instanceof \CI_Model) {
39		if (method_exists($table, 'getTableName')) {
40		$tableName = $table->getTableName();
		0 ignored issues – show Bug introduced 2016-10-14 06:57 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `CI_Model` as the method `getTableName()` does only exist in the following sub-classes of `CI_Model`: `Rougin\Wildfire\CodeigniterModel`, `Rougin\Wildfire\Wildfire`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
41		} elseif (property_exists($table, 'table')) {
42		// NOTE: To be removed in v1.0.0
43		$tableName = $table->table;
		0 ignored issues – show Bug introduced 2016-10-14 06:57 UTC by Report Bug Copy Issue Report The property `table` does not seem to exist in `CI_Model`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
44		}
45		}
46
47	36	if (! $isForeignKey && $this->table) {
48	24	$tableName = $this->table;
49	24	}
50
51	36	if (is_string($table)) {
52	36	$tableName = $table;
53	36	}
54
55	36	$tableName = ucfirst(singular($tableName));
56	36	$array = explode('.', $tableName);
57
58	36	return isset($array[1]) ? $array[1] : $tableName;
59		}
60
61		/**
62		* Sets the database class.
63		*
64		* @param \CI_DB\|null $database
65		* @return self
66		*/
67	39	public function setDatabase($database = null)
68		{
69	39	$ci = Instance::create();
70
71	39	$ci->load->helper('inflector');
		0 ignored issues – show Bug introduced 2016-06-04 16:18 UTC by Report Bug Copy Issue Report The property `load` does not seem to exist in `CI_Controller`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
72
73	39	if (empty($database)) {
74	3	$ci->load->database();
75
76	3	$this->db = $ci->db;
		0 ignored issues – show Bug introduced 2016-06-04 16:18 UTC by Report Bug Copy Issue Report The property `db` does not seem to exist in `CI_Controller`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
77
78	3	return $this;
79		}
80
81	39	$this->db = $database;
82
83	39	return $this;
84		}
85
86		/**
87		* Sets the query result.
88		*
89		* @param \CI_DB_result $query
90		* @return self
91		*/
92	3	public function setQuery($query)
93		{
94	3	$this->query = $query;
95
96	3	return $this;
97		}
98		}
99

rougin / wildfire

Pull Request — master (#2)

DatabaseTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like