BaseRepository::buildQuery() - Code Metrics - Inspection of "redone findOne through findAll" - hiqdev/hiapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a4169...fd1400 )

by Andrii

created 2017-07-21 16:27 UTC

BaseRepository::buildQuery() A

↳ Parent: BaseRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * HiAPI Yii2 base project for building API
 *
 * @link      https://github.com/hiqdev/hiapi
 * @package   hiapi
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
 */

namespace hiapi\repositories;

use hiapi\components\ConnectionInterface;
use hiapi\query\Specification;
use Yii;

abstract class BaseRepository extends \yii\base\Component
{
    /**
     * @var ConnectionInterface
     */
    protected $db;

    protected $factory;

    /**
     * @var string
     */
    public $queryClass;

    public function find(ActiveQuery $query)
    {
        $query->setRepository($this);

        return $query;
    }

    public function setRecordClass($value)
    {
        $this->recordClass = $value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function getRecordClass()
    {
        if ($this->recordClass === null) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->recordClass = $this->findRecordClass();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $this->recordClass;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function findRecordClass()
    {
        $parts = explode('\\', get_called_class());

        return implode('\\', $parts);
    }

    public function findAll(Specification $specification)

    {
        $query = $this->buildSelectQuery($specification);
        $rows = $query->createCommand($this->db)->queryAll();
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $rows = array_map(function ($row) use ($query) {
            return $query->restoreHierarchy($row);
        }, $rows);

        return $this->createMultiple($rows);
    }

    public function findOne(Specification $specification)
    {
        $rows = $this->findAll($specification->limit(1));

        return reset($rows);
    }

    public function old_findOne(Specification $specification)

    {
        $specification->limit(1);
        $query = $this->buildSelectQuery($specification);
        $row = $query->createCommand($this->db)->queryOne();
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $row = $query->restoreHierarchy($row);

        return $this->create($row);
    }

    protected function buildSelectQuery(Specification $specification)
    {
        return $specification->applyTo($this->buildQuery()->initSelect());
    }

    protected function buildQuery()
    {
        return Yii::createObject($this->getQueryClass());
    }

    protected function getQueryClass()
    {
        return $this->queryClass;
    }

    protected function createMultiple($rows)
    {
        $entities = [];
        foreach ($rows as $row) {
            $entities[] = $this->create($row);
        }

        return $entities;
    }

    protected function create(array $row)
    {
        return $this->factory->create($this->createDto($row));
    }

    protected function createDto(array $row)
    {
        $class = $this->getEntityCreationDtoClass();
        $dto = new $class();
        $props = array_keys(get_object_vars($dto));

        foreach ($props as $name) {
            if (isset($row[$name])) {
                $dto->$name = $row[$name];
            }
        }

        return $dto;
    }

    protected function getEntityCreationDtoClass()
    {
        $class = new \ReflectionClass($this->factory);
        $method = $class->getMethod('create');
        $arg = reset($method->getParameters());


        return $arg->getClass()->getName();
    }

    public function createEntity($entityClass, $row)
    {
        return Yii::$app->entityManager->getRepository($entityClass)->create($row);
    }
}


1		<?php
2		/**
3		* HiAPI Yii2 base project for building API
4		*
5		* @link https://github.com/hiqdev/hiapi
6		* @package hiapi
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiapi\repositories;
12
13		use hiapi\components\ConnectionInterface;
14		use hiapi\query\Specification;
15		use Yii;
16
17		abstract class BaseRepository extends \yii\base\Component
18		{
19		/**
20		* @var ConnectionInterface
21		*/
22		protected $db;
23
24		protected $factory;
25
26		/**
27		* @var string
28		*/
29		public $queryClass;
30
31		public function find(ActiveQuery $query)
32		{
33		$query->setRepository($this);
34
35		return $query;
36		}
37
38		public function setRecordClass($value)
39		{
40		$this->recordClass = $value;
		0 ignored issues – show Documentation introduced 2017-06-02 07:27 UTC by Report Bug Copy Issue Report The property `recordClass` does not exist on `object<hiapi\repositories\BaseRepository>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
41		}
42
43		public function getRecordClass()
44		{
45		if ($this->recordClass === null) {
		0 ignored issues – show Documentation introduced 2017-06-02 07:27 UTC by Report Bug Copy Issue Report The property `recordClass` does not exist on `object<hiapi\repositories\BaseRepository>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
46		$this->recordClass = $this->findRecordClass();
		0 ignored issues – show Documentation introduced 2017-06-02 07:27 UTC by Report Bug Copy Issue Report The property `recordClass` does not exist on `object<hiapi\repositories\BaseRepository>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
47		}
48
49		return $this->recordClass;
		0 ignored issues – show Documentation introduced 2017-06-02 07:27 UTC by Report Bug Copy Issue Report The property `recordClass` does not exist on `object<hiapi\repositories\BaseRepository>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
50		}
51
52		public function findRecordClass()
53		{
54		$parts = explode('\\', get_called_class());
55
56		return implode('\\', $parts);
57		}
58
59	View Code Duplication	public function findAll(Specification $specification)
		0 ignored issues – show Duplication introduced 2017-06-08 12:58 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...
60		{
61		$query = $this->buildSelectQuery($specification);
62		$rows = $query->createCommand($this->db)->queryAll();
		0 ignored issues – show Documentation introduced 2017-06-08 12:58 UTC by Report Bug Copy Issue Report `$this->db` is of type `object<hiapi\components\ConnectionInterface>`, but the function expects a `object<yii\db\Connection>\|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...
63		$rows = array_map(function ($row) use ($query) {
64		return $query->restoreHierarchy($row);
65		}, $rows);
66
67		return $this->createMultiple($rows);
68		}
69
70		public function findOne(Specification $specification)
71		{
72		$rows = $this->findAll($specification->limit(1));
73
74		return reset($rows);
75		}
76
77	View Code Duplication	public function old_findOne(Specification $specification)
		0 ignored issues – show Duplication introduced 2017-06-08 12:58 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...
78		{
79		$specification->limit(1);
80		$query = $this->buildSelectQuery($specification);
81		$row = $query->createCommand($this->db)->queryOne();
		0 ignored issues – show Documentation introduced 2017-06-08 12:58 UTC by Report Bug Copy Issue Report `$this->db` is of type `object<hiapi\components\ConnectionInterface>`, but the function expects a `object<yii\db\Connection>\|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...
82		$row = $query->restoreHierarchy($row);
83
84		return $this->create($row);
85		}
86
87		protected function buildSelectQuery(Specification $specification)
88		{
89		return $specification->applyTo($this->buildQuery()->initSelect());
90		}
91
92		protected function buildQuery()
93		{
94		return Yii::createObject($this->getQueryClass());
95		}
96
97		protected function getQueryClass()
98		{
99		return $this->queryClass;
100		}
101
102		protected function createMultiple($rows)
103		{
104		$entities = [];
105		foreach ($rows as $row) {
106		$entities[] = $this->create($row);
107		}
108
109		return $entities;
110		}
111
112		protected function create(array $row)
113		{
114		return $this->factory->create($this->createDto($row));
115		}
116
117		protected function createDto(array $row)
118		{
119		$class = $this->getEntityCreationDtoClass();
120		$dto = new $class();
121		$props = array_keys(get_object_vars($dto));
122
123		foreach ($props as $name) {
124		if (isset($row[$name])) {
125		$dto->$name = $row[$name];
126		}
127		}
128
129		return $dto;
130		}
131
132		protected function getEntityCreationDtoClass()
133		{
134		$class = new \ReflectionClass($this->factory);
135		$method = $class->getMethod('create');
136		$arg = reset($method->getParameters());
		0 ignored issues – show Bug introduced 2017-06-02 07:22 UTC by Report Bug Copy Issue Report `$method->getParameters()` cannot be passed to `reset()` as the parameter `$array` expects a reference. Loading history...
137
138		return $arg->getClass()->getName();
139		}
140
141		public function createEntity($entityClass, $row)
142		{
143		return Yii::$app->entityManager->getRepository($entityClass)->create($row);
144		}
145		}
146

hiqdev / hiapi

Push — master ( 4a4169...fd1400 )

BaseRepository::buildQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like