Mapper::addQueryScope() - Code Metrics - Inspection of "Moved the creation of subselects for `joinWith` fr..." - siriusphp/orm - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev_2x ( fa57a5...f00e1a )

by Adrian

created 2020-12-05 13:43 UTC

Mapper::addQueryScope() A

↳ Parent: Mapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10

<?php
declare(strict_types=1);

namespace Sirius\Orm;

use Sirius\Orm\Behaviour\BehaviourInterface;
use Sirius\Orm\Collection\Collection;
use Sirius\Orm\Contract\EntityInterface;
use Sirius\Orm\Contract\HydratorInterface;
use Sirius\Orm\Entity\GenericHydrator;
use Sirius\Orm\Entity\Patcher;
use Sirius\Orm\Relation\Relation;
use Sirius\Sql\Bindings;

/**
 * @method Query where($column, $value, $condition)
 * @method Query orderBy(string $expr, string ...$exprs)
 */
class Mapper
{
    /**
     * @var Orm
     */
    protected $orm;

    /**
     * @var ConnectionLocator
     */
    protected $connectionLocator;

    /**
     * @var MapperConfig
     */
    protected $mapperConfig;

    /**
     * @var HydratorInterface
     */
    protected $hydrator;

    /**
     * @var Behaviours
     */
    protected $behaviours;

    /**
     * @var array
     */
    protected $relations = [];

    public function __construct(Orm $orm)
    {
        $this->orm               = $orm;
        $this->connectionLocator = $orm->getConnectionLocator();
        $this->behaviours        = new Behaviours();
        $this->hydrator          = new GenericHydrator($this->orm->getCastingManager());
        $this->init();
    }

    protected function init()
    {
    }

    public function __call(string $method, array $params)
    {
        switch ($method) {
            case 'where':
            case 'orderBy':
                $query = $this->newQuery();

                return $query->{$method}(...$params);
        }

        throw new \BadMethodCallException("Unknown method {$method} for class " . get_class($this));
    }

    /**
     * @return MapperConfig
     */
    public function getConfig(): MapperConfig
    {
        return $this->mapperConfig;
    }

    /**
     * @return HydratorInterface
     */
    public function getHydrator(): HydratorInterface
    {
        return $this->hydrator;
    }

    /**
     * Add behaviours to the mapper
     *
     * @param mixed ...$behaviours
     */
    public function use(...$behaviours)
    {
        /** @var BehaviourInterface $behaviour */
        foreach ($behaviours as $behaviour) {
            $this->behaviours->add($behaviour);
        }
    }

    /**
     * Create a clone of the mapper without the selected behaviour
     *
     * @param mixed ...$behaviours
     *
     * @return self
     */
    public function without(...$behaviours)
    {
        $mapper             = clone $this;
        $mapper->behaviours = $this->behaviours->without(...$behaviours);

        return $mapper;
    }

    public function newEntity(array $data): EntityInterface
    {
        $entity = $this->getHydrator()
                       ->hydrate(array_merge(
                           $this->getConfig()->getAttributeDefaults(),
                           $data
                       ));

        return $this->behaviours->apply($this, __FUNCTION__, $entity);
    }

    public function newCollection(array $datas = []): Collection
    {
        $entities = [];
        foreach ($datas as $data) {
            // if $data is an entity or some other object, keep it as is
            $entities[] = (is_array($data)) ? $this->newEntity($data) : $data;
        }

        return new Collection($entities, $this->hydrator);
    }

    public function patch($entity, array $data)
    {
        return (new Patcher($this))($entity, $data);
    }

    /**
     * @param string $name
     * @param array|Relation $relation
     */
    public function addRelation(string $name, $relation)
    {
        if (is_array($relation) || $relation instanceof Relation) {

            $this->relations[$name] = $relation;

            return;
        }
        throw new \InvalidArgumentException(
            sprintf('The relation has to be a Relation instance or an array of configuration options')
        );
    }

    public function hasRelation(string $name): bool
    {
        return isset($this->relations[$name]);
    }

    public function getRelation(string $name): Relation
    {
        if (! $this->hasRelation($name)) {
            throw new \InvalidArgumentException("Relation named {$name} is not registered for this mapper");
        }

        if (is_array($this->relations[$name])) {
            $this->relations[$name] = $this->orm->createRelation($this, $name, $this->relations[$name]);
        }

        return $this->relations[$name];
    }

    public function getRelations(): array
    {
        return array_keys($this->relations);
    }

    public function newQuery(): Query
    {
        $query = new Query($this->getReadConnection(), $this);

        return $this->behaviours->apply($this, __FUNCTION__, $query);
    }

    public function newSubselectQuery(Connection $connection, Bindings $bindings, string $indent)
    {
        $query = new Query($connection, $this, $bindings, $indent);

        return $this->behaviours->apply($this, __FUNCTION__, $query);
    }

    public function getReadConnection(): Connection
    {
        return $this->connectionLocator->getRead();

    }

    public function getWriteConnection(): Connection
    {
        return $this->connectionLocator->getWrite();

    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Sirius\Orm;
5
6			use Sirius\Orm\Behaviour\BehaviourInterface;
7			use Sirius\Orm\Collection\Collection;
8			use Sirius\Orm\Contract\EntityInterface;
9			use Sirius\Orm\Contract\HydratorInterface;
10			use Sirius\Orm\Entity\GenericHydrator;
11			use Sirius\Orm\Entity\Patcher;
12			use Sirius\Orm\Relation\Relation;
13			use Sirius\Sql\Bindings;
14
15			/**
16			* @method Query where($column, $value, $condition)
17			* @method Query orderBy(string $expr, string ...$exprs)
18			*/
19			class Mapper
20			{
21			/**
22			* @var Orm
23			*/
24			protected $orm;
25
26			/**
27			* @var ConnectionLocator
28			*/
29			protected $connectionLocator;
30
31			/**
32			* @var MapperConfig
33			*/
34			protected $mapperConfig;
35
36			/**
37			* @var HydratorInterface
38			*/
39			protected $hydrator;
40
41			/**
42			* @var Behaviours
43			*/
44			protected $behaviours;
45
46			/**
47			* @var array
48			*/
49			protected $relations = [];
50
51			public function __construct(Orm $orm)
52			{
53			$this->orm = $orm;
54			$this->connectionLocator = $orm->getConnectionLocator();
55			$this->behaviours = new Behaviours();
56			$this->hydrator = new GenericHydrator($this->orm->getCastingManager());
57			$this->init();
58			}
59
60			protected function init()
61			{
62			}
63
64			public function __call(string $method, array $params)
65			{
66			switch ($method) {
67			case 'where':
68			case 'orderBy':
69			$query = $this->newQuery();
70
71			return $query->{$method}(...$params);
72			}
73
74			throw new \BadMethodCallException("Unknown method {$method} for class " . get_class($this));
75			}
76
77			/**
78			* @return MapperConfig
79			*/
80			public function getConfig(): MapperConfig
81			{
82			return $this->mapperConfig;
83			}
84
85			/**
86			* @return HydratorInterface
87			*/
88			public function getHydrator(): HydratorInterface
89			{
90			return $this->hydrator;
91			}
92
93			/**
94			* Add behaviours to the mapper
95			*
96			* @param mixed ...$behaviours
97			*/
98			public function use(...$behaviours)
99			{
100			/** @var BehaviourInterface $behaviour */
101			foreach ($behaviours as $behaviour) {
102			$this->behaviours->add($behaviour);
103			}
104			}
105
106			/**
107			* Create a clone of the mapper without the selected behaviour
108			*
109			* @param mixed ...$behaviours
110			*
111			* @return self
112			*/
113			public function without(...$behaviours)
114			{
115			$mapper = clone $this;
116			$mapper->behaviours = $this->behaviours->without(...$behaviours);
117
118			return $mapper;
119			}
120
121			public function newEntity(array $data): EntityInterface
122			{
123			$entity = $this->getHydrator()
124			->hydrate(array_merge(
125			$this->getConfig()->getAttributeDefaults(),
126			$data
127			));
128
129			return $this->behaviours->apply($this, __FUNCTION__, $entity);
130			}
131
132			public function newCollection(array $datas = []): Collection
133			{
134			$entities = [];
135			foreach ($datas as $data) {
136			// if $data is an entity or some other object, keep it as is
137			$entities[] = (is_array($data)) ? $this->newEntity($data) : $data;
138			}
139
140			return new Collection($entities, $this->hydrator);
141			}
142
143			public function patch($entity, array $data)
144			{
145			return (new Patcher($this))($entity, $data);
146			}
147
148			/**
149			* @param string $name
150			* @param array\|Relation $relation
151			*/
152			public function addRelation(string $name, $relation)
153			{
154			if (is_array($relation) \|\| $relation instanceof Relation) {
			0 ignored issues – show introduced 2020-11-28 17:14 UTC by Report Bug Copy Issue Report `$relation` is always a sub-type of `Sirius\Orm\Relation\Relation`. Loading history...
155			$this->relations[$name] = $relation;
156
157			return;
158			}
159			throw new \InvalidArgumentException(
160			sprintf('The relation has to be a Relation instance or an array of configuration options')
161			);
162			}
163
164			public function hasRelation(string $name): bool
165			{
166			return isset($this->relations[$name]);
167			}
168
169			public function getRelation(string $name): Relation
170			{
171			if (! $this->hasRelation($name)) {
172			throw new \InvalidArgumentException("Relation named {$name} is not registered for this mapper");
173			}
174
175			if (is_array($this->relations[$name])) {
176			$this->relations[$name] = $this->orm->createRelation($this, $name, $this->relations[$name]);
177			}
178
179			return $this->relations[$name];
180			}
181
182			public function getRelations(): array
183			{
184			return array_keys($this->relations);
185			}
186
187			public function newQuery(): Query
188			{
189			$query = new Query($this->getReadConnection(), $this);
190
191			return $this->behaviours->apply($this, __FUNCTION__, $query);
192			}
193
194			public function newSubselectQuery(Connection $connection, Bindings $bindings, string $indent)
195			{
196			$query = new Query($connection, $this, $bindings, $indent);
197
198			return $this->behaviours->apply($this, __FUNCTION__, $query);
199			}
200
201			public function getReadConnection(): Connection
202			{
203			return $this->connectionLocator->getRead();
			0 ignored issues – show Bug Best Practice introduced 2020-10-20 14:42 UTC by Report Bug Copy Issue Report The expression `return $this->connectionLocator->getRead()` returns the type `Atlas\Pdo\Connection` which includes types incompatible with the type-hinted return `Sirius\Orm\Connection`. Loading history...
204			}
205
206			public function getWriteConnection(): Connection
207			{
208			return $this->connectionLocator->getWrite();
			0 ignored issues – show Bug Best Practice introduced 2020-10-20 14:42 UTC by Report Bug Copy Issue Report The expression `return $this->connectionLocator->getWrite()` returns the type `Atlas\Pdo\Connection` which includes types incompatible with the type-hinted return `Sirius\Orm\Connection`. Loading history...
209			}
210			}
211

siriusphp / orm

Push — dev_2x ( fa57a5...f00e1a )

Mapper::addQueryScope() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like