ModelCollection::jsonSerialize() - Code Metrics - Inspection of "\JsonSerializable is not required anymore on model" - chubbyphp/chubbyphp-model - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 74b41a...e78beb )

by Dominik

created 2017-04-27 11:59 UTC

ModelCollection::jsonSerialize() A

↳ Parent: ModelCollection

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	11
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	11
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	0
crap	2

<?php

declare(strict_types=1);

namespace Chubbyphp\Model\Collection;

use Chubbyphp\Model\ModelInterface;
use Chubbyphp\Model\ModelSortTrait;

final class ModelCollection implements ModelCollectionInterface
{
    use ModelSortTrait;

    /**
     * @var string
     */
    private $modelClass;

    /**
     * @var string
     */
    private $foreignField;

    /**
     * @var string
     */
    private $foreignId;

    /**
     * @var array|null
     */
    private $orderBy;

    /**
     * @var ModelInterface[]|array
     */
    private $models;

    /**
     * @var \ReflectionProperty
     */
    private $propertyReflection;

    /**
     * @param string $modelClass
     * @param string $foreignField
     * @param string $foreignId
     * @param array|null $orderBy
     */
    public function __construct(

        string $modelClass,
        string $foreignField,
        string $foreignId,
        array $orderBy = null
    ) {
        $this->modelClass = $modelClass;
        $this->foreignField = $foreignField;
        $this->foreignId = $foreignId;
        $this->orderBy = $orderBy;

        $this->models = [];

        $this->propertyReflection = new \ReflectionProperty($this->modelClass, $this->foreignField);
        $this->propertyReflection->setAccessible(true);
    }

    /**
     * @param ModelInterface $model
     *
     * @return ModelCollectionInterface
     */
    public function addModel(ModelInterface $model): ModelCollectionInterface

    {
        $this->propertyReflection->setValue($model, $this->foreignId);

        $this->models[$model->getId()] = $model;

        return $this;
    }

    /**
     * @param ModelInterface $model
     *
     * @return ModelCollectionInterface
     */
    public function removeModel(ModelInterface $model): ModelCollectionInterface

    {
        if (isset($this->models[$model->getId()])) {
            $this->propertyReflection->setValue($model, null);

            unset($this->models[$model->getId()]);
        }

        return $this;
    }

    /**
     * @param ModelInterface[]|array $models
     *
     * @return ModelCollectionInterface
     */
    public function setModels(array $models): ModelCollectionInterface

    {
        foreach ($this->models as $model) {
            $this->removeModel($model);
        }
        foreach ($models as $model) {
            $this->addModel($model);
        }

        return $this;
    }

    /**
     * @return ModelInterface[]|array
     */
    public function getModels(): array
    {
        return $this->sort($this->modelClass, array_values($this->models), $this->orderBy);
    }

    /**
     * @return ModelInterface[]|array
     */
    public function getInitialModels(): array
    {
        return [];
    }

    /**
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->getModels());
    }

    /**
     * @return int
     */
    public function count()
    {
        return count($this->getModels());
    }

    /**
     * @return array
     */
    public function jsonSerialize(): array

    {
        $this->jsonSerializableOrException();

        $serializedModels = [];
        foreach ($this->getModels() as $model) {
            $serializedModels[] = $model->jsonSerialize();
        }

        return $serializedModels;
    }

    /**
     * @throws \LogicException
     */
    private function jsonSerializableOrException()

    {
        if (!in_array(\JsonSerializable::class, class_implements($this->modelClass), true)) {
            throw new \LogicException(
                sprintf('Model %s does not implement %s', $this->modelClass, \JsonSerializable::class)
            );
        }
    }

    /**
     * @return string
     */
    public function getForeignField(): string
    {
        return $this->foreignField;
    }

    /**
     * @return string
     */
    public function getForeignId(): string
    {
        return $this->foreignId;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Chubbyphp\Model\Collection;
6
7			use Chubbyphp\Model\ModelInterface;
8			use Chubbyphp\Model\ModelSortTrait;
9
10			final class ModelCollection implements ModelCollectionInterface
11			{
12			use ModelSortTrait;
13
14			/**
15			* @var string
16			*/
17			private $modelClass;
18
19			/**
20			* @var string
21			*/
22			private $foreignField;
23
24			/**
25			* @var string
26			*/
27			private $foreignId;
28
29			/**
30			* @var array\|null
31			*/
32			private $orderBy;
33
34			/**
35			* @var ModelInterface[]\|array
36			*/
37			private $models;
38
39			/**
40			* @var \ReflectionProperty
41			*/
42			private $propertyReflection;
43
44			/**
45			* @param string $modelClass
46			* @param string $foreignField
47			* @param string $foreignId
48			* @param array\|null $orderBy
49			*/
50	11	View Code Duplication	public function __construct(
			0 ignored issues – show Duplication introduced 2016-12-29 12:25 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...
51			string $modelClass,
52			string $foreignField,
53			string $foreignId,
54			array $orderBy = null
55			) {
56	11		$this->modelClass = $modelClass;
57	11		$this->foreignField = $foreignField;
58	11		$this->foreignId = $foreignId;
59	11		$this->orderBy = $orderBy;
60
61	11		$this->models = [];
62
63	11		$this->propertyReflection = new \ReflectionProperty($this->modelClass, $this->foreignField);
64	11		$this->propertyReflection->setAccessible(true);
65	11		}
66
67			/**
68			* @param ModelInterface $model
69			*
70			* @return ModelCollectionInterface
71			*/
72	1	View Code Duplication	public function addModel(ModelInterface $model): ModelCollectionInterface
			0 ignored issues – show Duplication introduced 2017-01-08 18:41 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...
73			{
74	1		$this->propertyReflection->setValue($model, $this->foreignId);
75
76	1		$this->models[$model->getId()] = $model;
77
78	1		return $this;
79			}
80
81			/**
82			* @param ModelInterface $model
83			*
84			* @return ModelCollectionInterface
85			*/
86	1	View Code Duplication	public function removeModel(ModelInterface $model): ModelCollectionInterface
			0 ignored issues – show Duplication introduced 2016-11-24 20:14 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...
87			{
88	1		if (isset($this->models[$model->getId()])) {
89	1		$this->propertyReflection->setValue($model, null);
90
91	1		unset($this->models[$model->getId()]);
92			}
93
94	1		return $this;
95			}
96
97			/**
98			* @param ModelInterface[]\|array $models
99			*
100			* @return ModelCollectionInterface
101			*/
102	1	View Code Duplication	public function setModels(array $models): ModelCollectionInterface
			0 ignored issues – show Duplication introduced 2017-04-03 19:45 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...
103			{
104	1		foreach ($this->models as $model) {
105			$this->removeModel($model);
106			}
107	1		foreach ($models as $model) {
108	1		$this->addModel($model);
109			}
110
111	1		return $this;
112			}
113
114			/**
115			* @return ModelInterface[]\|array
116			*/
117	2		public function getModels(): array
118			{
119	2		return $this->sort($this->modelClass, array_values($this->models), $this->orderBy);
120			}
121
122			/**
123			* @return ModelInterface[]\|array
124			*/
125	1		public function getInitialModels(): array
126			{
127	1		return [];
128			}
129
130			/**
131			* @return \ArrayIterator
132			*/
133	1		public function getIterator()
134			{
135	1		return new \ArrayIterator($this->getModels());
136			}
137
138			/**
139			* @return int
140			*/
141	1		public function count()
142			{
143	1		return count($this->getModels());
144			}
145
146			/**
147			* @return array
148			*/
149	1	View Code Duplication	public function jsonSerialize(): array
			0 ignored issues – show Duplication introduced 2017-04-27 12:06 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...
150			{
151	1		$this->jsonSerializableOrException();
152
153	1		$serializedModels = [];
154	1		foreach ($this->getModels() as $model) {
155	1		$serializedModels[] = $model->jsonSerialize();
156			}
157
158	1		return $serializedModels;
159			}
160
161			/**
162			* @throws \LogicException
163			*/
164		View Code Duplication	private function jsonSerializableOrException()
			0 ignored issues – show Duplication introduced 2017-04-27 12:06 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...
165			{
166			if (!in_array(\JsonSerializable::class, class_implements($this->modelClass), true)) {
167			throw new \LogicException(
168			sprintf('Model %s does not implement %s', $this->modelClass, \JsonSerializable::class)
169			);
170			}
171			}
172
173			/**
174			* @return string
175			*/
176	1		public function getForeignField(): string
177			{
178	1		return $this->foreignField;
179			}
180
181			/**
182			* @return string
183			*/
184	1		public function getForeignId(): string
185			{
186	1		return $this->foreignId;
187			}
188			}
189

chubbyphp / chubbyphp-model

Push — master ( 74b41a...e78beb )

ModelCollection::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like