AbstractRelation::getUrl() - Code Metrics - Inspection of "Added extra method for loading the initial draft o..." - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 108e84...f077fb )

by Joschi

created 2016-08-01 08:42 UTC

AbstractRelation::getUrl() A

↳ Parent: AbstractRelation

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	2
Bugs	0	Features	0

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

<?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\ApparatUrl;
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|ApparatUrl
     */
    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|ApparatUrl URL
     */
    public function getUrl()
    {
        return $this->url;
    }

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

apparat / object

Push — master ( 108e84...f077fb )

AbstractRelation::getUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like