SystemPropertiesTrait::getLatitude() - Code Metrics - Inspection of "Added location support" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 863650...abf17e )

by Joschi

created 2016-05-10 19:38 UTC

SystemPropertiesTrait::getLatitude() A

↳ Parent: SystemPropertiesTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Domain
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Domain\Model\Object\Traits;

use Apparat\Object\Domain\Model\Object\Id;
use Apparat\Object\Domain\Model\Object\Revision;
use Apparat\Object\Domain\Model\Object\Type;
use Apparat\Object\Domain\Model\Properties\SystemProperties;

/**
 * System properties trait
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
trait SystemPropertiesTrait
{
    /**
     * System properties
     *
     * @var SystemProperties
     */
    protected $systemProperties;

    /**
     * Return the object revision
     *
     * @return Revision Object revision
     */
    public function getRevision()
    {
        return $this->systemProperties->getRevision();
    }

    /**
     * Return the object ID
     *
     * @return Id Object ID
     */
    public function getId()
    {
        return $this->systemProperties->getId();
    }

    /**
     * Return the object type
     *
     * @return Type Object type
     */
    public function getType()
    {
        return $this->systemProperties->getType();
    }

    /**
     * Return the creation date & time
     *
     * @return \DateTimeImmutable Creation date & time
     */
    public function getCreated()
    {
        return $this->systemProperties->getCreated();
    }

    /**
     * Return the publication date & time
     *
     * @return \DateTimeImmutable|null Publication date & time
     */
    public function getPublished()
    {
        return $this->systemProperties->getPublished();
    }

    /**
     * Return the object hash
     *
     * @return string Object hash
     */
    public function getHash()
    {
        return $this->systemProperties->getHash();
    }

    /**
     * Return the latitude
     *
     * @return float Latitude
     */
    public function getLatitude()
    {
        return $this->systemProperties->getLatitude();
    }

    /**
     * Set the latitude
     *
     * @param float $latitude Latitude
     * @return SystemProperties Self reference
     */
    public function setLatitude($latitude)
    {
        $this->setSystemProperties($this->systemProperties->setLatitude($latitude));
        return $this;
    }

    /**
     * Set the system properties collection
     *
     * @param SystemProperties $systemProperties System property collection
     * @param bool $overwrite Overwrite the existing collection (if present)
     */
    protected function setSystemProperties(SystemProperties $systemProperties, $overwrite = false)
    {
        $this->systemProperties = $systemProperties;
        $systemPropertiesState = spl_object_hash($this->systemProperties);

        // If the system property collection state has changed
        if (!$overwrite
            && !empty($this->collectionStates[SystemProperties::COLLECTION])
class MyClass { }

$x = new MyClass();
$x->foo = true;
            && ($systemPropertiesState !== $this->collectionStates[SystemProperties::COLLECTION])
        ) {
            // Flag this object as mutated
            $this->setDirtyState();
        }

        $this->collectionStates[SystemProperties::COLLECTION] = $systemPropertiesState;
    }

    /**
     * Return the longitude
     *
     * @return float Longitude
     */
    public function getLongitude()
    {
        return $this->systemProperties->getLongitude();
    }

    /**
     * Set the longitude
     *
     * @param float $longitude Longitude
     * @return SystemProperties Self reference
     */
    public function setLongitude($longitude)
    {
        $this->setSystemProperties($this->systemProperties->setLongitude($longitude));
        return $this;
    }

    /**
     * Return the elevation
     *
     * @return float Elevation
     */
    public function getElevation()
    {
        return $this->systemProperties->getElevation();
    }

    /**
     * Set the elevation
     *
     * @param float $elevation
     * @return SystemProperties Self reference
     */
    public function setElevation($elevation)
    {
        $this->setSystemProperties($this->systemProperties->setElevation($elevation));
        return $this;
    }

    /**
     * Set the object state to dirty
     */
    abstract protected function setDirtyState();
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Domain
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Apparat\Object\Domain\Model\Object\Traits;
38
39		use Apparat\Object\Domain\Model\Object\Id;
40		use Apparat\Object\Domain\Model\Object\Revision;
41		use Apparat\Object\Domain\Model\Object\Type;
42		use Apparat\Object\Domain\Model\Properties\SystemProperties;
43
44		/**
45		* System properties trait
46		*
47		* @package Apparat\Object
48		* @subpackage Apparat\Object\Domain
49		*/
50		trait SystemPropertiesTrait
51		{
52		/**
53		* System properties
54		*
55		* @var SystemProperties
56		*/
57		protected $systemProperties;
58
59		/**
60		* Return the object revision
61		*
62		* @return Revision Object revision
63		*/
64	20	public function getRevision()
65		{
66	20	return $this->systemProperties->getRevision();
67		}
68
69		/**
70		* Return the object ID
71		*
72		* @return Id Object ID
73		*/
74	5	public function getId()
75		{
76	5	return $this->systemProperties->getId();
77		}
78
79		/**
80		* Return the object type
81		*
82		* @return Type Object type
83		*/
84	1	public function getType()
85		{
86	1	return $this->systemProperties->getType();
87		}
88
89		/**
90		* Return the creation date & time
91		*
92		* @return \DateTimeImmutable Creation date & time
93		*/
94	1	public function getCreated()
95		{
96	1	return $this->systemProperties->getCreated();
97		}
98
99		/**
100		* Return the publication date & time
101		*
102		* @return \DateTimeImmutable\|null Publication date & time
103		*/
104	1	public function getPublished()
105		{
106	1	return $this->systemProperties->getPublished();
107		}
108
109		/**
110		* Return the object hash
111		*
112		* @return string Object hash
113		*/
114	1	public function getHash()
115		{
116	1	return $this->systemProperties->getHash();
117		}
118
119		/**
120		* Return the latitude
121		*
122		* @return float Latitude
123		*/
124	1	public function getLatitude()
125		{
126	1	return $this->systemProperties->getLatitude();
127		}
128
129		/**
130		* Set the latitude
131		*
132		* @param float $latitude Latitude
133		* @return SystemProperties Self reference
134		*/
135	1	public function setLatitude($latitude)
136		{
137	1	$this->setSystemProperties($this->systemProperties->setLatitude($latitude));
138	1	return $this;
139		}
140
141		/**
142		* Set the system properties collection
143		*
144		* @param SystemProperties $systemProperties System property collection
145		* @param bool $overwrite Overwrite the existing collection (if present)
146		*/
147	1	protected function setSystemProperties(SystemProperties $systemProperties, $overwrite = false)
148		{
149	1	$this->systemProperties = $systemProperties;
150	1	$systemPropertiesState = spl_object_hash($this->systemProperties);
151
152		// If the system property collection state has changed
153	1	if (!$overwrite
154	1	&& !empty($this->collectionStates[SystemProperties::COLLECTION])
		0 ignored issues – show Bug introduced 2016-05-10 19:41 UTC by Report Bug Copy Issue Report The property `collectionStates` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
155	1	&& ($systemPropertiesState !== $this->collectionStates[SystemProperties::COLLECTION])
156		) {
157		// Flag this object as mutated
158	1	$this->setDirtyState();
159		}
160
161	1	$this->collectionStates[SystemProperties::COLLECTION] = $systemPropertiesState;
162	1	}
163
164		/**
165		* Return the longitude
166		*
167		* @return float Longitude
168		*/
169	1	public function getLongitude()
170		{
171	1	return $this->systemProperties->getLongitude();
172		}
173
174		/**
175		* Set the longitude
176		*
177		* @param float $longitude Longitude
178		* @return SystemProperties Self reference
179		*/
180	1	public function setLongitude($longitude)
181		{
182	1	$this->setSystemProperties($this->systemProperties->setLongitude($longitude));
183	1	return $this;
184		}
185
186		/**
187		* Return the elevation
188		*
189		* @return float Elevation
190		*/
191		public function getElevation()
192		{
193		return $this->systemProperties->getElevation();
194		}
195
196		/**
197		* Set the elevation
198		*
199		* @param float $elevation
200		* @return SystemProperties Self reference
201		*/
202	1	public function setElevation($elevation)
203		{
204	1	$this->setSystemProperties($this->systemProperties->setElevation($elevation));
205		return $this;
206		}
207
208		/**
209		* Set the object state to dirty
210		*/
211		abstract protected function setDirtyState();
212		}
213

apparat / object

Push — master ( 863650...abf17e )

SystemPropertiesTrait::getLatitude() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like