AbstractRelation::getSignature() - Code Metrics - Inspection of "Enabled public object discovery by selector" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 299541...2cf242 )

by Joschi

created 2016-06-20 21:49 UTC

AbstractRelation::getSignature() A

↳ Parent: AbstractRelation

Complexity

Conditions	4
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4.0466

Importance

Changes	5
Bugs	0	Features	2

Metric	Value
c	5
b	0
f	2
dl	0
loc	9
cc	4
eloc	6
nc	1
nop	0
ccs	6
cts	7
cp	0.8571
crap	4.0466
rs	9.2

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\<Layer>
 * @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\Relation;

use Apparat\Object\Domain\Model\Uri\Url;

/**
 * Abstract base relation
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
abstract class AbstractRelation implements RelationInterface
{
    /**
     * Relation type
     *
     * @var string
     */
    const TYPE = 'abstract';
    /**
     * Relation URL
     *
     * @var Url
     */
    protected $url = null;
    /**
     * Relation label
     *
     * @var string
     */
    protected $label = null;
    /**
     * Relation email
     *
     * @var string
     */
    protected $email = null;
    /**
     * Coupling
     *
     * @var int
     */
    protected $coupling = self::LOOSE_COUPLING;

    /**
     * @param Url $url Relation URL
     * @param string $label Relation label
     * @param string $email Relation email
     * @param int $coupling Coupling
     * @throws OutOfBoundsException If the object coupling is invalid
     */
    public function __construct(
        Url $url = null,
        $label = null,
        $email = null,
        $coupling = null
    ) {
        // If the coupling type is invalid
        if (($coupling !== self::LOOSE_COUPLING) && ($coupling !== self::TIGHT_COUPLING)) {
            throw new OutOfBoundsException(
                sprintf('Invalid object coupling "%s"', $coupling),
                OutOfBoundsException::INVALID_OBJECT_COUPLING
            );
        }

        $this->url = $url;
        $this->label = $label;
        $this->email = $email;
        $this->coupling = $coupling;
    }

    /**
     * Return the URL
     *
     * @return Url URL
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * Set the URL
     *
     * @param Url|null $url URL
     * @return RelationInterface Self reference
     */
    public function setUrl(Url $url = null)
    {
        $relation = clone $this;
        $relation->url = $url;
        return $relation;
    }

    /**
     * Return the label
     *
     * @return string|null Label
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**
     * Set the label
     *
     * @param string|null $label Label
     * @return RelationInterface Self reference
     */
    public function setLabel($label)
    {
        $relation = clone $this;
        $relation->label = $label;
        return $relation;
    }

    /**
     * Return the email address
     *
     * @return string|null Email address
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * Set the email address
     *
     * @param string|null $email Email address
     * @return RelationInterface Self reference
     */
    public function setEmail($email)
    {
        $relation = clone $this;
        $relation->email = $email;
        return $relation;
    }

    /**
     * Return the coupling
     *
     * @return int Coupling
     */
    public function getCoupling()
    {
        return $this->coupling;
    }

    /**
     * Set the coupling
     *
     * @param int $coupling Coupling
     * @return RelationInterface Self reference
     * @throws OutOfBoundsException If the object coupling is invalid
     */
    public function setCoupling($coupling)
    {
        // If the coupling type is invalid
        if (($coupling !== self::LOOSE_COUPLING) && ($coupling !== self::TIGHT_COUPLING)) {
            throw new OutOfBoundsException(
                sprintf('Invalid object coupling "%s"', $coupling),
                OutOfBoundsException::INVALID_OBJECT_COUPLING
            );
        }

        $relation = clone $this;
        $relation->coupling = $coupling;
        return $relation;
    }

    /**
     * Return the unique relation signature
     *
     * @return string Relation signature
     */
    public function getSignature()
    {
        return md5(
            $this->getType().
            (empty($this->url)
                ? (empty($this->email) ? (empty($this->label) ? '-' : $this->label) : $this->email)
                : $this->url)
        );
    }

    /**
     * Return the relation type
     *
     * @return string Relation type
     */
    public function getType()
    {
        return static::TYPE;
    }

    /**
     * Serialize the property
     *
     * @return mixed Property serialization
     */
    public function __toString()
    {
        $relationParts = [$this->url, empty($this->email) ? null : '<'.$this->email.'>', $this->label];
        return implode(' ', array_filter($relationParts));
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\<Layer>
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\Relation;
38
39		use Apparat\Object\Domain\Model\Uri\Url;
40
41		/**
42		* Abstract base relation
43		*
44		* @package Apparat\Object
45		* @subpackage Apparat\Object\Domain
46		*/
47		abstract class AbstractRelation implements RelationInterface
48		{
49		/**
50		* Relation type
51		*
52		* @var string
53		*/
54		const TYPE = 'abstract';
55		/**
56		* Relation URL
57		*
58		* @var Url
59		*/
60		protected $url = null;
61		/**
62		* Relation label
63		*
64		* @var string
65		*/
66		protected $label = null;
67		/**
68		* Relation email
69		*
70		* @var string
71		*/
72		protected $email = null;
73		/**
74		* Coupling
75		*
76		* @var int
77		*/
78		protected $coupling = self::LOOSE_COUPLING;
79
80		/**
81		* @param Url $url Relation URL
82		* @param string $label Relation label
83		* @param string $email Relation email
84		* @param int $coupling Coupling
85		* @throws OutOfBoundsException If the object coupling is invalid
86		*/
87	33	public function __construct(
88		Url $url = null,
89		$label = null,
90		$email = null,
91		$coupling = null
92		) {
93		// If the coupling type is invalid
94	33	if (($coupling !== self::LOOSE_COUPLING) && ($coupling !== self::TIGHT_COUPLING)) {
95	1	throw new OutOfBoundsException(
96	1	sprintf('Invalid object coupling "%s"', $coupling),
97		OutOfBoundsException::INVALID_OBJECT_COUPLING
98	1	);
99		}
100
101	32	$this->url = $url;
102	32	$this->label = $label;
103	32	$this->email = $email;
104	32	$this->coupling = $coupling;
105	32	}
106
107		/**
108		* Return the URL
109		*
110		* @return Url URL
111		*/
112	2	public function getUrl()
113		{
114	2	return $this->url;
115		}
116
117		/**
118		* Set the URL
119		*
120		* @param Url\|null $url URL
121		* @return RelationInterface Self reference
122		*/
123	1	public function setUrl(Url $url = null)
124		{
125	1	$relation = clone $this;
126	1	$relation->url = $url;
127	1	return $relation;
128		}
129
130		/**
131		* Return the label
132		*
133		* @return string\|null Label
134		*/
135	1	public function getLabel()
136		{
137	1	return $this->label;
138		}
139
140		/**
141		* Set the label
142		*
143		* @param string\|null $label Label
144		* @return RelationInterface Self reference
145		*/
146	1	public function setLabel($label)
147		{
148	1	$relation = clone $this;
149	1	$relation->label = $label;
150	1	return $relation;
151		}
152
153		/**
154		* Return the email address
155		*
156		* @return string\|null Email address
157		*/
158	2	public function getEmail()
159		{
160	2	return $this->email;
161		}
162
163		/**
164		* Set the email address
165		*
166		* @param string\|null $email Email address
167		* @return RelationInterface Self reference
168		*/
169	1	public function setEmail($email)
170		{
171	1	$relation = clone $this;
172	1	$relation->email = $email;
173	1	return $relation;
174		}
175
176		/**
177		* Return the coupling
178		*
179		* @return int Coupling
180		*/
181	1	public function getCoupling()
182		{
183	1	return $this->coupling;
184		}
185
186		/**
187		* Set the coupling
188		*
189		* @param int $coupling Coupling
190		* @return RelationInterface Self reference
191		* @throws OutOfBoundsException If the object coupling is invalid
192		*/
193	1	public function setCoupling($coupling)
194		{
195		// If the coupling type is invalid
196	1	if (($coupling !== self::LOOSE_COUPLING) && ($coupling !== self::TIGHT_COUPLING)) {
197	1	throw new OutOfBoundsException(
198	1	sprintf('Invalid object coupling "%s"', $coupling),
199		OutOfBoundsException::INVALID_OBJECT_COUPLING
200	1	);
201		}
202
203	1	$relation = clone $this;
204	1	$relation->coupling = $coupling;
205	1	return $relation;
206		}
207
208		/**
209		* Return the unique relation signature
210		*
211		* @return string Relation signature
212		*/
213	31	public function getSignature()
214		{
215	31	return md5(
216	31	$this->getType().
217		(empty($this->url)
218	31	? (empty($this->email) ? (empty($this->label) ? '-' : $this->label) : $this->email)
219	31	: $this->url)
220	31	);
221		}
222
223		/**
224		* Return the relation type
225		*
226		* @return string Relation type
227		*/
228	31	public function getType()
229		{
230	31	return static::TYPE;
231		}
232
233		/**
234		* Serialize the property
235		*
236		* @return mixed Property serialization
237		*/
238	4	public function __toString()
239		{
240	4	$relationParts = [$this->url, empty($this->email) ? null : '<'.$this->email.'>', $this->label];
241	4	return implode(' ', array_filter($relationParts));
242		}
243		}
244

apparat / object

Push — master ( 299541...2cf242 )

AbstractRelation::getSignature() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like