RegionEntity - Code Metrics - geobase/php-countries - Measure and Improve Code Quality continuously with Scrutinizer

RegionEntity B
last analyzed 2017-03-06 21:53 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	472
Duplicated Lines	2.12 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

47.86%

Importance

Changes

Metric	Value
wmc	40
lcom	1
cbo	5
dl	10
loc	472
ccs	56
cts	117
cp	0.4786
rs	8.2608
c	0
b	0
f	0

37 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	10	10	1
A	jsonSerialize()	0	17	1
A	getPolygon()	0	4	1
A	setPolygon()	0	6	1
A	getBoundingBox()	0	4	1
A	setBoundingBox()	0	6	1
A	getCode()	0	4	1
A	setCode()	0	6	1
A	getLongCode()	0	4	1
A	setLongCode()	0	6	1
A	getCoordinate()	0	4	1
A	setCoordinate()	0	6	1
A	getLatitude()	0	4	1
A	setLatitude()	0	7	1
A	getLongitude()	0	4	1
A	setLongitude()	0	7	1
A	getNames()	0	4	1
A	setNames()	0	6	1
A	getTimezone()	0	4	1
A	setTimezone()	0	6	1
A	getType()	0	4	1
A	setType()	0	6	1
A	getNorth()	0	4	1
A	setNorth()	0	7	1
A	getEast()	0	4	1
A	setEast()	0	7	1
A	getSouth()	0	4	1
A	setSouth()	0	7	1
A	getWest()	0	4	1
A	setWest()	0	7	1
A	getCountry()	0	8	3
A	setCountry()	0	10	2
A	getUnmappedCountry()	0	4	1
A	setUnmappedCountry()	0	6	1
A	normalizeLatitude()	0	4	1
A	normalizeLongitude()	0	4	1
A	getEllipsoid()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like RegionEntity often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use RegionEntity, and based on these observations, apply Extract Interface, too.

<?php

namespace GeoBase\Regions\Region;

use GeoBase\Countries\Coordinate\CoordinateCollectionInterface;
use GeoBase\Countries\Coordinate\CoordinateLogic;
use GeoBase\Countries\Country\CountryEntity;
use GeoBase\Countries\Geo;
use GeoBase\Regions\Region\RegionName\RegionNameCollection;
use GeoBase\Regions\Region\Type\TypeInterface;
use JsonSerializable;
use League\Geotools\BoundingBox\BoundingBox;
use League\Geotools\Coordinate\Coordinate;
use League\Geotools\Polygon\Polygon;

class RegionEntity extends CoordinateLogic implements JsonSerializable, CoordinateCollectionInterface
{
    /**
     * @var Coordinate
     */
    protected $coordinate;

    /**
     * @var BoundingBox
     */
    protected $boundingBox;

    /**
     * @var RegionNameCollection
     */
    protected $names;

    /**
     * @var CountryEntity
     */
    protected $country;

    /**
     * @var Polygon
     */
    protected $polygon;

    /**
     * @var string
     */
    protected $unmappedCountry;

    /**
     * @var string
     */
    protected $code;

    /**
     * @var string
     */
    protected $longCode;

    /**
     * @var TypeInterface|string
     */
    protected $type;

    /**
     * @var string
     */
    protected $timezone;

    /**
     * @var string
     */
    protected $latitude;

    /**
     * @var string
     */
    protected $longitude;

    /**
     * @var string
     */
    protected $north;

    /**
     * @var string
     */
    protected $east;

    /**
     * @var string
     */
    protected $south;

    /**
     * @var string
     */
    protected $west;

    public function __construct()

    {
        $this->boundingBox = new BoundingBox();
        $this->polygon = new Polygon();
        $this->coordinate = new Coordinate([
            $this->latitude,
            $this->longitude,
        ]);
        $this->setNames(new RegionNameCollection());
    }

    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'names'     => $this->getNames(),
            'code'      => $this->getCode(),
            'long_code' => $this->getLongCode(),
            'type'      => $this->getType(),
            'country'   => $this->getCountry(),
            'timezone'  => $this->getTimezone(),
            'latitude'  => $this->getLatitude(),
            'longitude' => $this->getLongitude(),
            'north'     => $this->getNorth(),
            'east'      => $this->getEast(),
            'south'     => $this->getSouth(),
            'west'      => $this->getWest(),
        ];
    }

    /**
     * @return Polygon
     */
    public function getPolygon()
    {
        return $this->polygon;
    }

    /**
     * @param Polygon $polygon
     *
     * @return $this
     */
    public function setPolygon(Polygon $polygon)
    {
        $this->polygon = $polygon;

        return $this;
    }

    /**
     * @return BoundingBox
     */
    public function getBoundingBox()
    {
        return $this->boundingBox;
    }

    /**
     * @param BoundingBox $boundingBox
     *
     * @return $this
     */
    public function setBoundingBox(BoundingBox $boundingBox)
    {
        $this->boundingBox = $boundingBox;

        return $this;
    }

    /**
     * @return string
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * @param string $code
     *
     * @return $this
     */
    public function setCode($code)
    {
        $this->code = $code;

        return $this;
    }

    /**
     * @return string
     */
    public function getLongCode()
    {
        return $this->longCode;
    }

    /**
     * @param string $longCode
     *
     * @return $this
     */
    public function setLongCode($longCode)
    {
        $this->longCode = $longCode;

        return $this;
    }

    /**
     * @return Coordinate
     */
    public function getCoordinate()
    {
        return $this->coordinate;
    }

    /**
     * @param Coordinate $coordinate
     *
     * @return $this
     */
    public function setCoordinate(Coordinate $coordinate)
    {
        $this->coordinate = $coordinate;

        return $this;
    }

    /**
     * @return string
     */
    public function getLatitude()
    {
        return $this->latitude;
    }

    /**
     * @param string $latitude
     *
     * @return $this
     */
    public function setLatitude($latitude)
    {
        $this->latitude = $latitude;
        $this->coordinate->setLatitude($this->latitude);

        return $this;
    }

    /**
     * @return string
     */
    public function getLongitude()
    {
        return $this->longitude;
    }

    /**
     * @param string $longitude
     *
     * @return $this
     */
    public function setLongitude($longitude)
    {
        $this->longitude = $longitude;
        $this->coordinate->setLongitude($this->longitude);

        return $this;
    }

    /**
     * @return RegionNameCollection
     */
    public function getNames()
    {
        return $this->names;
    }

    /**
     * @param RegionNameCollection $names
     *
     * @return $this
     */
    public function setNames(RegionNameCollection $names)
    {
        $this->names = $names;

        return $this;
    }

    /**
     * @return string
     */
    public function getTimezone()
    {
        return $this->timezone;
    }

    /**
     * @param string $timezone
     *
     * @return $this
     */
    public function setTimezone($timezone)
    {
        $this->timezone = $timezone;

        return $this;
    }

    /**
     * @return TypeInterface|string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param TypeInterface|string $type
     *
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return string
     */
    public function getNorth()
    {
        return $this->north;
    }

    /**
     * @param string $north
     *
     * @return $this
     */
    public function setNorth($north)
    {
        $this->getBoundingBox()->setNorth($north);
        $this->north = $north;

        return $this;
    }

    /**
     * @return string
     */
    public function getEast()
    {
        return $this->east;
    }

    /**
     * @param string $east
     *
     * @return $this
     */
    public function setEast($east)
    {
        $this->getBoundingBox()->setEast($east);
        $this->east = $east;

        return $this;
    }

    /**
     * @return string
     */
    public function getSouth()
    {
        return $this->south;
    }

    /**
     * @param string $south
     *
     * @return $this
     */
    public function setSouth($south)
    {
        $this->getBoundingBox()->setSouth($south);
        $this->south = $south;

        return $this;
    }

    /**
     * @return string
     */
    public function getWest()
    {
        return $this->west;
    }

    /**
     * @param string $west
     *
     * @return $this
     */
    public function setWest($west)
    {
        $this->getBoundingBox()->setWest($west);
        $this->west = $west;

        return $this;
    }

    /**
     * @return CountryEntity
     */
    public function getCountry()
    {
        if (null !== $this->unmappedCountry && null === $this->country) {
            $this->country = Geo::getCountryRepository()->findByShortCode($this->unmappedCountry);
        }

        return $this->country;
    }

    /**
     * @param CountryEntity|string $country
     *
     * @return $this
     */
    public function setCountry($country)
    {
        if (is_string($country)) {
            $this->unmappedCountry = $country;
        } else {
            $this->country = $country;
        }

        return $this;
    }

    /**
     * @return string
     */
    public function getUnmappedCountry()
    {
        return $this->unmappedCountry;
    }

    /**
     * @param string $unmappedCountry
     *
     * @return $this
     */
    public function setUnmappedCountry($unmappedCountry)
    {
        $this->unmappedCountry = $unmappedCountry;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function normalizeLatitude($latitude)
    {
        return $this->coordinate->normalizeLatitude($latitude);
    }

    /**
     * {@inheritdoc}
     */
    public function normalizeLongitude($longitude)
    {
        return $this->coordinate->normalizeLongitude($longitude);
    }

    /**
     * {@inheritdoc}
     */
    public function getEllipsoid()
    {
        return $this->coordinate->getEllipsoid();
    }
}


1			<?php
2
3			namespace GeoBase\Regions\Region;
4
5			use GeoBase\Countries\Coordinate\CoordinateCollectionInterface;
6			use GeoBase\Countries\Coordinate\CoordinateLogic;
7			use GeoBase\Countries\Country\CountryEntity;
8			use GeoBase\Countries\Geo;
9			use GeoBase\Regions\Region\RegionName\RegionNameCollection;
10			use GeoBase\Regions\Region\Type\TypeInterface;
11			use JsonSerializable;
12			use League\Geotools\BoundingBox\BoundingBox;
13			use League\Geotools\Coordinate\Coordinate;
14			use League\Geotools\Polygon\Polygon;
15
16			class RegionEntity extends CoordinateLogic implements JsonSerializable, CoordinateCollectionInterface
17			{
18			/**
19			* @var Coordinate
20			*/
21			protected $coordinate;
22
23			/**
24			* @var BoundingBox
25			*/
26			protected $boundingBox;
27
28			/**
29			* @var RegionNameCollection
30			*/
31			protected $names;
32
33			/**
34			* @var CountryEntity
35			*/
36			protected $country;
37
38			/**
39			* @var Polygon
40			*/
41			protected $polygon;
42
43			/**
44			* @var string
45			*/
46			protected $unmappedCountry;
47
48			/**
49			* @var string
50			*/
51			protected $code;
52
53			/**
54			* @var string
55			*/
56			protected $longCode;
57
58			/**
59			* @var TypeInterface\|string
60			*/
61			protected $type;
62
63			/**
64			* @var string
65			*/
66			protected $timezone;
67
68			/**
69			* @var string
70			*/
71			protected $latitude;
72
73			/**
74			* @var string
75			*/
76			protected $longitude;
77
78			/**
79			* @var string
80			*/
81			protected $north;
82
83			/**
84			* @var string
85			*/
86			protected $east;
87
88			/**
89			* @var string
90			*/
91			protected $south;
92
93			/**
94			* @var string
95			*/
96			protected $west;
97
98	4	View Code Duplication	public function __construct()
			0 ignored issues – show Duplication introduced 2017-03-06 21:12 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...
99			{
100	4		$this->boundingBox = new BoundingBox();
101	4		$this->polygon = new Polygon();
102	4		$this->coordinate = new Coordinate([
103	4		$this->latitude,
104	4		$this->longitude,
105			]);
106	4		$this->setNames(new RegionNameCollection());
107	4		}
108
109			/**
110			* @return array
111			*/
112			public function jsonSerialize()
113			{
114			return [
115			'names' => $this->getNames(),
116			'code' => $this->getCode(),
117			'long_code' => $this->getLongCode(),
118			'type' => $this->getType(),
119			'country' => $this->getCountry(),
120			'timezone' => $this->getTimezone(),
121			'latitude' => $this->getLatitude(),
122			'longitude' => $this->getLongitude(),
123			'north' => $this->getNorth(),
124			'east' => $this->getEast(),
125			'south' => $this->getSouth(),
126			'west' => $this->getWest(),
127			];
128			}
129
130			/**
131			* @return Polygon
132			*/
133			public function getPolygon()
134			{
135			return $this->polygon;
136			}
137
138			/**
139			* @param Polygon $polygon
140			*
141			* @return $this
142			*/
143			public function setPolygon(Polygon $polygon)
144			{
145			$this->polygon = $polygon;
146
147			return $this;
148			}
149
150			/**
151			* @return BoundingBox
152			*/
153	4		public function getBoundingBox()
154			{
155	4		return $this->boundingBox;
156			}
157
158			/**
159			* @param BoundingBox $boundingBox
160			*
161			* @return $this
162			*/
163			public function setBoundingBox(BoundingBox $boundingBox)
164			{
165			$this->boundingBox = $boundingBox;
166
167			return $this;
168			}
169
170			/**
171			* @return string
172			*/
173	3		public function getCode()
174			{
175	3		return $this->code;
176			}
177
178			/**
179			* @param string $code
180			*
181			* @return $this
182			*/
183	4		public function setCode($code)
184			{
185	4		$this->code = $code;
186
187	4		return $this;
188			}
189
190			/**
191			* @return string
192			*/
193			public function getLongCode()
194			{
195			return $this->longCode;
196			}
197
198			/**
199			* @param string $longCode
200			*
201			* @return $this
202			*/
203	4		public function setLongCode($longCode)
204			{
205	4		$this->longCode = $longCode;
206
207	4		return $this;
208			}
209
210			/**
211			* @return Coordinate
212			*/
213			public function getCoordinate()
214			{
215			return $this->coordinate;
216			}
217
218			/**
219			* @param Coordinate $coordinate
220			*
221			* @return $this
222			*/
223			public function setCoordinate(Coordinate $coordinate)
224			{
225			$this->coordinate = $coordinate;
226
227			return $this;
228			}
229
230			/**
231			* @return string
232			*/
233			public function getLatitude()
234			{
235			return $this->latitude;
236			}
237
238			/**
239			* @param string $latitude
240			*
241			* @return $this
242			*/
243	4		public function setLatitude($latitude)
244			{
245	4		$this->latitude = $latitude;
246	4		$this->coordinate->setLatitude($this->latitude);
247
248	4		return $this;
249			}
250
251			/**
252			* @return string
253			*/
254			public function getLongitude()
255			{
256			return $this->longitude;
257			}
258
259			/**
260			* @param string $longitude
261			*
262			* @return $this
263			*/
264	4		public function setLongitude($longitude)
265			{
266	4		$this->longitude = $longitude;
267	4		$this->coordinate->setLongitude($this->longitude);
268
269	4		return $this;
270			}
271
272			/**
273			* @return RegionNameCollection
274			*/
275	4		public function getNames()
276			{
277	4		return $this->names;
278			}
279
280			/**
281			* @param RegionNameCollection $names
282			*
283			* @return $this
284			*/
285	4		public function setNames(RegionNameCollection $names)
286			{
287	4		$this->names = $names;
288
289	4		return $this;
290			}
291
292			/**
293			* @return string
294			*/
295			public function getTimezone()
296			{
297			return $this->timezone;
298			}
299
300			/**
301			* @param string $timezone
302			*
303			* @return $this
304			*/
305	4		public function setTimezone($timezone)
306			{
307	4		$this->timezone = $timezone;
308
309	4		return $this;
310			}
311
312			/**
313			* @return TypeInterface\|string
314			*/
315			public function getType()
316			{
317			return $this->type;
318			}
319
320			/**
321			* @param TypeInterface\|string $type
322			*
323			* @return $this
324			*/
325	4		public function setType($type)
326			{
327	4		$this->type = $type;
328
329	4		return $this;
330			}
331
332			/**
333			* @return string
334			*/
335			public function getNorth()
336			{
337			return $this->north;
338			}
339
340			/**
341			* @param string $north
342			*
343			* @return $this
344			*/
345	4		public function setNorth($north)
346			{
347	4		$this->getBoundingBox()->setNorth($north);
348	4		$this->north = $north;
349
350	4		return $this;
351			}
352
353			/**
354			* @return string
355			*/
356			public function getEast()
357			{
358			return $this->east;
359			}
360
361			/**
362			* @param string $east
363			*
364			* @return $this
365			*/
366	4		public function setEast($east)
367			{
368	4		$this->getBoundingBox()->setEast($east);
369	4		$this->east = $east;
370
371	4		return $this;
372			}
373
374			/**
375			* @return string
376			*/
377			public function getSouth()
378			{
379			return $this->south;
380			}
381
382			/**
383			* @param string $south
384			*
385			* @return $this
386			*/
387	4		public function setSouth($south)
388			{
389	4		$this->getBoundingBox()->setSouth($south);
390	4		$this->south = $south;
391
392	4		return $this;
393			}
394
395			/**
396			* @return string
397			*/
398			public function getWest()
399			{
400			return $this->west;
401			}
402
403			/**
404			* @param string $west
405			*
406			* @return $this
407			*/
408	4		public function setWest($west)
409			{
410	4		$this->getBoundingBox()->setWest($west);
411	4		$this->west = $west;
412
413	4		return $this;
414			}
415
416			/**
417			* @return CountryEntity
418			*/
419			public function getCountry()
420			{
421			if (null !== $this->unmappedCountry && null === $this->country) {
422			$this->country = Geo::getCountryRepository()->findByShortCode($this->unmappedCountry);
423			}
424
425			return $this->country;
426			}
427
428			/**
429			* @param CountryEntity\|string $country
430			*
431			* @return $this
432			*/
433			public function setCountry($country)
434			{
435			if (is_string($country)) {
436			$this->unmappedCountry = $country;
437			} else {
438			$this->country = $country;
439			}
440
441			return $this;
442			}
443
444			/**
445			* @return string
446			*/
447			public function getUnmappedCountry()
448			{
449			return $this->unmappedCountry;
450			}
451
452			/**
453			* @param string $unmappedCountry
454			*
455			* @return $this
456			*/
457	4		public function setUnmappedCountry($unmappedCountry)
458			{
459	4		$this->unmappedCountry = $unmappedCountry;
460
461	4		return $this;
462			}
463
464			/**
465			* {@inheritdoc}
466			*/
467			public function normalizeLatitude($latitude)
468			{
469			return $this->coordinate->normalizeLatitude($latitude);
470			}
471
472			/**
473			* {@inheritdoc}
474			*/
475			public function normalizeLongitude($longitude)
476			{
477			return $this->coordinate->normalizeLongitude($longitude);
478			}
479
480			/**
481			* {@inheritdoc}
482			*/
483			public function getEllipsoid()
484			{
485			return $this->coordinate->getEllipsoid();
486			}
487			}
488

geobase / php-countries

RegionEntity B last analyzed 2017-03-06 21:53 UTC