CodeigniterModel::find_by() - Code Metrics - Inspection of "Add Traits\PaginateTrait" - rougin/credo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Rougin

created 2016-10-28 19:19 UTC

CodeigniterModel::find_by() 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->findBy([]);
    }

    /**
     * Returns a total rows from the specified table.
     *
     * @return integer
     */
    public function countAll()
    {
        list($tableName, $primaryKey) = $this->getTableNameAndPrimaryKey();

        $queryBuilder = $this->credo->createQueryBuilder();

        $queryBuilder->select($queryBuilder->expr()->count($tableName . '.' . $primaryKey));

        $queryBuilder->from(get_class($this), $tableName);

        return $queryBuilder->getQuery()->getSingleScalarResult();

    }

    /**
     * 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)
    {
        list($tableName) = $this->getTableNameAndPrimaryKey();

        $this->db->insert($tableName, $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)
    {
        list($tableName, $primaryKey) = $this->getTableNameAndPrimaryKey();

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

        $result = $this->db->update($tableName);

        $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;
    }

    /**
     * Returns the table name and the corresponding primary key.
     *
     * @return array
     */
    protected function getTableNameAndPrimaryKey()
    {
        $factory  = $this->credo->getMetadataFactory();
        $metadata = $factory->getMetadataFor(get_class($this));

        return [ $metadata->getTableName(), $metadata->getSingleIdentifierColumnName() ];
    }
}


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->findBy([]);
41	3	}
42
43		/**
44		* Returns a total rows from the specified table.
45		*
46		* @return integer
47		*/
48	3	public function countAll()
49		{
50	3	list($tableName, $primaryKey) = $this->getTableNameAndPrimaryKey();
51
52	3	$queryBuilder = $this->credo->createQueryBuilder();
53
54	3	$queryBuilder->select($queryBuilder->expr()->count($tableName . '.' . $primaryKey));
		0 ignored issues – show Bug introduced 2016-10-28 19:23 UTC by Report Bug Copy Issue Report The method `count()` does not seem to exist on `object<Doctrine\DBAL\Que...sion\ExpressionBuilder>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
55	3	$queryBuilder->from(get_class($this), $tableName);
56
57	3	return $queryBuilder->getQuery()->getSingleScalarResult();
		0 ignored issues – show Bug introduced 2016-10-28 19:23 UTC by Report Bug Copy Issue Report The method `getQuery()` does not exist on `Doctrine\DBAL\Query\QueryBuilder`. Did you maybe mean `getQueryPart()`? 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...
58		}
59
60		/**
61		* Deletes the specified ID of the model from the database.
62		*
63		* @param integer $id
64		* @return void
65		*/
66	3	public function delete($id)
67		{
68	3	$item = $this->find($id);
69
70	3	if (! is_null($item)) {
71	3	$this->credo->remove($item);
72	3	$this->credo->flush();
73	3	}
74	3	}
75
76		/**
77		* Finds an entity by its primary key / identifier.
78		*
79		* @param mixed $id
80		* @param int\|null $lockMode
81		* @param int\|null $lockVersion
82		* @return object\|null
83		*/
84	9	public function find($id, $lockMode = null, $lockVersion = null)
85		{
86	9	return $this->repository->find($id, $lockMode, $lockVersion);
87	3	}
88
89		/**
90		* Finds models by a set of criteria.
91		*
92		* @param array $criteria
93		* @param array\|null $orderBy
94		* @param integer\|null $limit
95		* @param integer\|null $offset
96		* @return array
97		*/
98	6	public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
99		{
100	6	return $this->repository->findBy($criteria, $orderBy, $limit, $offset);
101		}
102
103		/**
104		* Inserts a new row into the table.
105		*
106		* @param array $data
107		* @return integer
108		*/
109	3	public function insert(array $data)
110		{
111	3	list($tableName) = $this->getTableNameAndPrimaryKey();
112
113	3	$this->db->insert($tableName, $data);
114
115	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...
116
117	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...
118
119	3	return $lastId;
120		}
121
122		/**
123		* Updates the selected row from the table.
124		*
125		* @param integer $id
126		* @param array $data
127		* @return boolean
128		*/
129	3	public function update($id, array $data)
130		{
131	3	list($tableName, $primaryKey) = $this->getTableNameAndPrimaryKey();
132
133	3	$this->db->where($primaryKey, $id);
134	3	$this->db->set($data);
135
136	3	$result = $this->db->update($tableName);
137
138	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...
139
140	3	return $result;
141		}
142
143		/**
144		* Returns the table name and the corresponding primary key.
145		*
146		* @return array
147		*/
148	9	protected function getTableNameAndPrimaryKey()
149		{
150	9	$factory = $this->credo->getMetadataFactory();
151	9	$metadata = $factory->getMetadataFor(get_class($this));
152
153	9	return [ $metadata->getTableName(), $metadata->getSingleIdentifierColumnName() ];
154		}
155		}
156

rougin / credo

Pull Request — master (#4)

CodeigniterModel::find_by() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like