Address::__clone() - Code Metrics - Inspection of "Merge pull request #10 from kingsquare/add-clone-m..." - kingsquare/communibase-entity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 432fe2...c3ceb1 )

by Misha

created 2020-10-12 21:53 UTC

Address::__clone() A

↳ Parent: Address

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	6
rs	10
cc	2
nc	2
nop	0

<?php

declare(strict_types=1);

namespace Communibase\Entity;

use Communibase\CommunibaseId;
use Communibase\DataBag;
use Communibase\Exception\InvalidGeoLocationException;

/**
 * Communibase Address
 *
 * @author Kingsquare ([email protected])
 * @copyright Copyright (c) Kingsquare BV (http://www.kingsquare.nl)
 */
class Address
{
    /**
     * @var DataBag;
     */
    protected $dataBag;

    protected function __construct(array $addressData = [])
    {
        $this->dataBag = DataBag::create();
        if ($addressData === []) {
            return;
        }
        $this->dataBag->addEntityData('address', $addressData);
    }

    /**
     * @return static
     */
    public static function create()
    {
        return new static();
    }

    /**
     * @return static
     */
    public static function fromAddressData(array $addressData = null)
    {
        if ($addressData === null) {
            $addressData = [];
        }
        return new static($addressData);
    }

    public function getProperty(): string
    {
        return (string)$this->dataBag->get('address.property');
    }

    public function setProperty(string $property): void
    {
        $this->dataBag->set('address.property', $property);
    }

    public function getStreet(): string
    {
        return trim((string)$this->dataBag->get('address.street'));
    }

    public function setStreet(string $street): void
    {
        $this->dataBag->set('address.street', $street);
    }

    public function getStreetNumber(): string
    {
        return (string)$this->dataBag->get('address.streetNumber');
    }

    public function setStreetNumber(string $streetNumber): void
    {
        $this->dataBag->set('address.streetNumber', $streetNumber);
    }

    public function getStreetNumberAddition(): string
    {
        return (string)$this->dataBag->get('address.streetNumberAddition');
    }

    public function setStreetNumberAddition(string $streetNumberAddition): void
    {
        $this->dataBag->set('address.streetNumberAddition', $streetNumberAddition);
    }

    public function getZipcode(): string
    {
        return trim((string)$this->dataBag->get('address.zipcode'));
    }

    public function setZipcode(string $zipcode): void
    {
        $this->dataBag->set('address.zipcode', $zipcode);
    }

    public function getCity(): string
    {
        return trim((string)$this->dataBag->get('address.city'));
    }

    public function setCity(string $city): void
    {
        $this->dataBag->set('address.city', $city);
    }

    public function getCountryCode(string $default = 'NL'): string
    {
        return trim((string)$this->dataBag->get('address.countryCode', $default));
    }

    public function setCountryCode(string $countryCode): void
    {
        $this->dataBag->set('address.countryCode', $countryCode);
    }

    public function getType(): string
    {
        return trim((string)$this->dataBag->get('address.type'));
    }

    public function setType(string $type): void
    {
        $this->dataBag->set('address.type', $type);
    }

    public function getId(): CommunibaseId
    {
        return CommunibaseId::fromString($this->dataBag->get('address._id'));
    }

    public function __toString()
    {
        return $this->toString();
    }

    public function toString(bool $singleLine = true): string
    {
        if ($this->getState() === null) {
            return '';
        }
        $lines = [
            array_filter([$this->getStreet(), $this->getStreetNumber(), $this->getStreetNumberAddition()]),
            array_filter([$this->getZipcode(), $this->getCity()]),
        ];

        if ($singleLine) {
            return implode(
                ', ',
                array_filter(
                    [
                        implode(' ', $lines[0]),
                        implode(', ', $lines[1]),
                    ]
                )
            );
        }
        return implode(
            PHP_EOL,
            array_filter(
                [
                    implode(' ', $lines[0]),
                    implode(' ', $lines[1]),
                ]
            )
        );
    }

    /**
     * @return float[]|null
     */
    public function getGeoLocation(): ?array
    {
        // native geo handling
        if ($this->isGeoStorageUsingNativePoint()) {
            $point = $this->dataBag->get('address.point');
            if (empty($point) || empty($point['coordinates']) || empty($point['coordinates'][0]) || empty($point['coordinates'][1])) {
                return null;
            }
            return [
                'lat' => (float)$point['coordinates'][1],
                'lng' => (float)$point['coordinates'][0],
            ];
        }

        // `old`-style
        $lat = $this->dataBag->get('address.latitude');
        $lng = $this->dataBag->get('address.longitude');
        if (!isset($lat, $lng)) {
            return null;
        }
        return [
            'lat' => (float)$lat,
            'lng' => (float)$lng,
        ];
    }

    /**
     * @throws InvalidGeoLocationException
     */
    public function setGeoLocation(float $latitude, float $longitude): void
    {
        $this->guardAgainstInvalidLatLong($latitude, $longitude);

        // native geo handling
        if ($this->isGeoStorageUsingNativePoint()) {
            $this->dataBag->set(
                'address.point',
                [
                    'coordinates' => [
                        0 => $longitude,
                        1 => $latitude,
                    ],
                ]
            );
            return;
        }
        $this->dataBag->set('address.latitude', $latitude);
        $this->dataBag->set('address.longitude', $longitude);
    }

    private function isGeoStorageUsingNativePoint(): bool
    {
        return !empty($this->dataBag->get('address.point'));
    }

    /**
     * @return bool
     */
    public function isEmpty(): bool
    {
        return empty(
        array_filter(
            [
                $this->getStreet(),
                $this->getStreetNumber(),
                $this->getZipcode(),
                $this->getCity()
            ]
        )
        );
    }

    public function __clone()
    {
        $state = $this->getState();
        if ($state !== null) {
            unset($state['_id']);
            $this->dataBag->addEntityData('address', $state);
        }
    }

    /**
     * @return array|null
     */
    public function getState(): ?array
    {
        if ($this->isEmpty()) {
            return null;
        }
        return $this->dataBag->getState('address');
    }

    /**
     * @throws InvalidGeoLocationException
     */
    protected function guardAgainstInvalidLatLong(float $latitude, float $longitude): void
    {
        if ($latitude < -90 || $latitude > 90 || $longitude < -180 || $longitude > 180) {
            throw new InvalidGeoLocationException(
                \sprintf('Invalid latitude/longitude: %s, %s', $latitude, $longitude)
            );
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Communibase\Entity;
6
7			use Communibase\CommunibaseId;
8			use Communibase\DataBag;
9			use Communibase\Exception\InvalidGeoLocationException;
10
11			/**
12			* Communibase Address
13			*
14			* @author Kingsquare ([email protected])
15			* @copyright Copyright (c) Kingsquare BV (http://www.kingsquare.nl)
16			*/
17			class Address
18			{
19			/**
20			* @var DataBag;
21			*/
22			protected $dataBag;
23
24			protected function __construct(array $addressData = [])
25			{
26			$this->dataBag = DataBag::create();
27			if ($addressData === []) {
28			return;
29			}
30			$this->dataBag->addEntityData('address', $addressData);
31			}
32
33			/**
34			* @return static
35			*/
36			public static function create()
37			{
38			return new static();
39			}
40
41			/**
42			* @return static
43			*/
44			public static function fromAddressData(array $addressData = null)
45			{
46			if ($addressData === null) {
47			$addressData = [];
48			}
49			return new static($addressData);
50			}
51
52			public function getProperty(): string
53			{
54			return (string)$this->dataBag->get('address.property');
55			}
56
57			public function setProperty(string $property): void
58			{
59			$this->dataBag->set('address.property', $property);
60			}
61
62			public function getStreet(): string
63			{
64			return trim((string)$this->dataBag->get('address.street'));
65			}
66
67			public function setStreet(string $street): void
68			{
69			$this->dataBag->set('address.street', $street);
70			}
71
72			public function getStreetNumber(): string
73			{
74			return (string)$this->dataBag->get('address.streetNumber');
75			}
76
77			public function setStreetNumber(string $streetNumber): void
78			{
79			$this->dataBag->set('address.streetNumber', $streetNumber);
80			}
81
82			public function getStreetNumberAddition(): string
83			{
84			return (string)$this->dataBag->get('address.streetNumberAddition');
85			}
86
87			public function setStreetNumberAddition(string $streetNumberAddition): void
88			{
89			$this->dataBag->set('address.streetNumberAddition', $streetNumberAddition);
90			}
91
92			public function getZipcode(): string
93			{
94			return trim((string)$this->dataBag->get('address.zipcode'));
95			}
96
97			public function setZipcode(string $zipcode): void
98			{
99			$this->dataBag->set('address.zipcode', $zipcode);
100			}
101
102			public function getCity(): string
103			{
104			return trim((string)$this->dataBag->get('address.city'));
105			}
106
107			public function setCity(string $city): void
108			{
109			$this->dataBag->set('address.city', $city);
110			}
111
112			public function getCountryCode(string $default = 'NL'): string
113			{
114			return trim((string)$this->dataBag->get('address.countryCode', $default));
115			}
116
117			public function setCountryCode(string $countryCode): void
118			{
119			$this->dataBag->set('address.countryCode', $countryCode);
120			}
121
122			public function getType(): string
123			{
124			return trim((string)$this->dataBag->get('address.type'));
125			}
126
127			public function setType(string $type): void
128			{
129			$this->dataBag->set('address.type', $type);
130			}
131
132			public function getId(): CommunibaseId
133			{
134			return CommunibaseId::fromString($this->dataBag->get('address._id'));
135			}
136
137			public function __toString()
138			{
139			return $this->toString();
140			}
141
142			public function toString(bool $singleLine = true): string
143			{
144			if ($this->getState() === null) {
145			return '';
146			}
147			$lines = [
148			array_filter([$this->getStreet(), $this->getStreetNumber(), $this->getStreetNumberAddition()]),
149			array_filter([$this->getZipcode(), $this->getCity()]),
150			];
151
152			if ($singleLine) {
153			return implode(
154			', ',
155			array_filter(
156			[
157			implode(' ', $lines[0]),
158			implode(', ', $lines[1]),
159			]
160			)
161			);
162			}
163			return implode(
164			PHP_EOL,
165			array_filter(
166			[
167			implode(' ', $lines[0]),
168			implode(' ', $lines[1]),
169			]
170			)
171			);
172			}
173
174			/**
175			* @return float[]\|null
176			*/
177			public function getGeoLocation(): ?array
178			{
179			// native geo handling
180			if ($this->isGeoStorageUsingNativePoint()) {
181			$point = $this->dataBag->get('address.point');
182			if (empty($point) \|\| empty($point['coordinates']) \|\| empty($point['coordinates'][0]) \|\| empty($point['coordinates'][1])) {
183			return null;
184			}
185			return [
186			'lat' => (float)$point['coordinates'][1],
187			'lng' => (float)$point['coordinates'][0],
188			];
189			}
190
191			// `old`-style
192			$lat = $this->dataBag->get('address.latitude');
193			$lng = $this->dataBag->get('address.longitude');
194			if (!isset($lat, $lng)) {
195			return null;
196			}
197			return [
198			'lat' => (float)$lat,
199			'lng' => (float)$lng,
200			];
201			}
202
203			/**
204			* @throws InvalidGeoLocationException
205			*/
206			public function setGeoLocation(float $latitude, float $longitude): void
207			{
208			$this->guardAgainstInvalidLatLong($latitude, $longitude);
209
210			// native geo handling
211			if ($this->isGeoStorageUsingNativePoint()) {
212			$this->dataBag->set(
213			'address.point',
214			[
215			'coordinates' => [
216			0 => $longitude,
217			1 => $latitude,
218			],
219			]
220			);
221			return;
222			}
223			$this->dataBag->set('address.latitude', $latitude);
224			$this->dataBag->set('address.longitude', $longitude);
225			}
226
227			private function isGeoStorageUsingNativePoint(): bool
228			{
229			return !empty($this->dataBag->get('address.point'));
230			}
231
232			/**
233			* @return bool
234			*/
235			public function isEmpty(): bool
236			{
237			return empty(
238			array_filter(
239			[
240			$this->getStreet(),
241			$this->getStreetNumber(),
242			$this->getZipcode(),
243			$this->getCity()
244			]
245			)
246			);
247			}
248
249			public function __clone()
250			{
251			$state = $this->getState();
252			if ($state !== null) {
253			unset($state['_id']);
254			$this->dataBag->addEntityData('address', $state);
255			}
256			}
257
258			/**
259			* @return array\|null
260			*/
261			public function getState(): ?array
262			{
263			if ($this->isEmpty()) {
264			return null;
265			}
266			return $this->dataBag->getState('address');
267			}
268
269			/**
270			* @throws InvalidGeoLocationException
271			*/
272			protected function guardAgainstInvalidLatLong(float $latitude, float $longitude): void
273			{
274			if ($latitude < -90 \|\| $latitude > 90 \|\| $longitude < -180 \|\| $longitude > 180) {
275			throw new InvalidGeoLocationException(
276			\sprintf('Invalid latitude/longitude: %s, %s', $latitude, $longitude)
277			);
278			}
279			}
280			}
281

kingsquare / communibase-entity

Push — master ( 432fe2...c3ceb1 )

Address::__clone() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like