CodeigniterModel::findBy() - Code Metrics - Inspection of "Add __call in Credo, EntityRepository and Codeigni..." - rougin/credo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Rougin

created 2016-10-27 02:09 UTC

CodeigniterModel::findBy() A

↳ Parent: CodeigniterModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	4
crap	1

<?php

namespace Rougin\Credo;

/**
 * Codeigniter Model
 *
 * @package Credo
 * @author  Rougin Royce Gutib <[email protected]>
 *
 * @property \CI_DB_query_builder $db
 */
class CodeigniterModel extends \CI_Model
{
    /**
     * @var \Rougin\Credo\Credo
     */
    protected $credo;

    /**
     * @var \Doctrine\ORM\EntityRepository
     */
    protected $repository;

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

        $this->credo      = new Credo($this->db);
        $this->repository = $this->credo->getRepository(get_class($this));
    }

    /**
     * Returns all of the models from the database.
     *
     * @return array
     */
    public function all()
    {
        return $this->find_by([]);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Deletes the specified ID of the model from the database.
     *
     * @param  integer $id
     * @return void
     */
    public function delete($id)
    {
        $item = $this->find($id);

        if (! is_null($item)) {
            $this->credo->remove($item);
            $this->credo->flush();
        }
    }

    /**
     * Finds an entity by its primary key / identifier.
     *
     * @param  mixed    $id
     * @param  int|null $lockMode
     * @param  int|null $lockVersion
     * @return object|null
     */
    public function find($id, $lockMode = null, $lockVersion = null)
    {
        return $this->repository->find($id, $lockMode, $lockVersion);
    }

    /**
     * Finds models by a set of criteria.
     *
     * @param  array        $criteria
     * @param  array|null   $orderBy
     * @param  integer|null $limit
     * @param  integer|null $offset
     * @return array
     */
    public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
    {
        return $this->repository->findBy($criteria, $orderBy, $limit, $offset);
    }

    /**
     * Inserts a new row into the table.
     *
     * @param  array $data
     * @return integer
     */
    public function insert(array $data)
    {
        $factory  = $this->credo->getMetadataFactory();
        $metadata = $factory->getMetadataFor(get_class($this));

        $this->db->insert($metadata->getTableName(), $data);

        $lastId = $this->db->insert_id();


        $this->credo->refresh($this->find($lastId));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        return $lastId;
    }

    /**
     * Updates the selected row from the table.
     *
     * @param  integer $id
     * @param  array   $data
     * @return boolean
     */
    public function update($id, array $data)
    {
        $factory  = $this->credo->getMetadataFactory();
        $metadata = $factory->getMetadataFor(get_class($this));

        $this->db->where($metadata->getSingleIdentifierColumnName(), $id);
        $this->db->set($data);

        $result = $this->db->update($metadata->getTableName());

        $this->credo->refresh($this->find($id));
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        return $result;
    }

    /**
     * Calls methods from CodeigniterModel in underscore case.
     *
     * @param  string $method
     * @param  mixed  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        return \Rougin\Credo\Helpers\MagicMethodHelper::call($this, $method, $parameters);
    }
}


1		<?php
2
3		namespace Rougin\Credo;
4
5		/**
6		* Codeigniter Model
7		*
8		* @package Credo
9		* @author Rougin Royce Gutib <[email protected]>
10		*
11		* @property \CI_DB_query_builder $db
12		*/
13		class CodeigniterModel extends \CI_Model
14		{
15		/**
16		* @var \Rougin\Credo\Credo
17		*/
18		protected $credo;
19
20		/**
21		* @var \Doctrine\ORM\EntityRepository
22		*/
23		protected $repository;
24
25	3	public function __construct()
26		{
27	3	parent::__construct();
28
29	3	$this->credo = new Credo($this->db);
30	3	$this->repository = $this->credo->getRepository(get_class($this));
31	3	}
32
33		/**
34		* Returns all of the models from the database.
35		*
36		* @return array
37		*/
38	3	public function all()
39		{
40	3	return $this->find_by([]);
		0 ignored issues – show Documentation Bug introduced 2016-10-27 02:14 UTC by Report Bug Copy Issue Report The method `find_by` does not exist on `object<Rougin\Credo\CodeigniterModel>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
41		}
42
43		/**
44		* Deletes the specified ID of the model from the database.
45		*
46		* @param integer $id
47		* @return void
48		*/
49	3	public function delete($id)
50		{
51	3	$item = $this->find($id);
52
53	3	if (! is_null($item)) {
54	3	$this->credo->remove($item);
55	3	$this->credo->flush();
56	3	}
57	3	}
58
59		/**
60		* Finds an entity by its primary key / identifier.
61		*
62		* @param mixed $id
63		* @param int\|null $lockMode
64		* @param int\|null $lockVersion
65		* @return object\|null
66		*/
67	9	public function find($id, $lockMode = null, $lockVersion = null)
68		{
69	9	return $this->repository->find($id, $lockMode, $lockVersion);
70		}
71
72		/**
73		* Finds models by a set of criteria.
74		*
75		* @param array $criteria
76		* @param array\|null $orderBy
77		* @param integer\|null $limit
78		* @param integer\|null $offset
79		* @return array
80		*/
81	3	public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
82		{
83	3	return $this->repository->findBy($criteria, $orderBy, $limit, $offset);
84		}
85
86		/**
87		* Inserts a new row into the table.
88		*
89		* @param array $data
90		* @return integer
91		*/
92	3	public function insert(array $data)
93		{
94	3	$factory = $this->credo->getMetadataFactory();
95	3	$metadata = $factory->getMetadataFor(get_class($this));
96
97	3	$this->db->insert($metadata->getTableName(), $data);
98
99	3	$lastId = $this->db->insert_id();
		0 ignored issues – show Bug introduced 2016-10-20 06:24 UTC by Report Bug Copy Issue Report The method `insert_id()` does not exist on `CI_DB_query_builder`. Did you maybe mean `insert()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
100
101	3	$this->credo->refresh($this->find($lastId));
		0 ignored issues – show Documentation Bug introduced 2016-10-18 16:29 UTC by Report Bug Copy Issue Report The method `refresh` does not exist on `object<Rougin\Credo\Credo>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
102
103	3	return $lastId;
104		}
105
106		/**
107		* Updates the selected row from the table.
108		*
109		* @param integer $id
110		* @param array $data
111		* @return boolean
112		*/
113	3	public function update($id, array $data)
114		{
115	3	$factory = $this->credo->getMetadataFactory();
116	3	$metadata = $factory->getMetadataFor(get_class($this));
117
118	3	$this->db->where($metadata->getSingleIdentifierColumnName(), $id);
119	3	$this->db->set($data);
120
121	3	$result = $this->db->update($metadata->getTableName());
122
123	3	$this->credo->refresh($this->find($id));
		0 ignored issues – show Documentation Bug introduced 2016-10-18 16:29 UTC by Report Bug Copy Issue Report The method `refresh` does not exist on `object<Rougin\Credo\Credo>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
124
125	3	return $result;
126		}
127
128		/**
129		* Calls methods from CodeigniterModel in underscore case.
130		*
131		* @param string $method
132		* @param mixed $parameters
133		* @return mixed
134		*/
135	3	public function __call($method, $parameters)
136		{
137	3	return \Rougin\Credo\Helpers\MagicMethodHelper::call($this, $method, $parameters);
138		}
139		}
140

rougin / credo

Pull Request — master (#3)

CodeigniterModel::findBy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like