Completed
Push — v2 ( a3e6f8...094005 )
by Joschi
07:34
created

Iri   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 82
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 82
c 1
b 0
f 0
wmc 8
lcom 0
cbo 2
ccs 18
cts 18
cp 1
rs 10

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A __get() 0 14 3
A __isset() 0 4 2
A __set() 0 4 1
A __toString() 0 4 1
1
<?php
2
3
/**
4
 * micrometa
5
 *
6
 * @category Jkphl
7
 * @package Jkphl\Micrometa
8
 * @subpackage Jkphl\Micrometa\Domain
9
 * @author Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright Copyright © 2017 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 © 2017 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 Jkphl\Micrometa\Domain\Item;
38
39
use Jkphl\Micrometa\Domain\Exceptions\ErrorException;
40
use Jkphl\Micrometa\Domain\Exceptions\OutOfBoundsException;
41
42
/**
43
 * IRI
44
 *
45
 * @package Jkphl\Micrometa
46
 * @subpackage Jkphl\Micrometa\Domain
47
 * @see https://tools.ietf.org/html/rfc3987
48
 * @property string $profile Profile
49
 * @property string $name Name
50
 */
51
class Iri
52
{
53
    /**
54
     * Profile
55
     *
56
     * @var string
57
     */
58
    protected $immutableProfile;
59
    /**
60
     * Name
61
     *
62
     * @var string
63
     */
64
    protected $immutableName;
65
66
    /**
67
     * Constructor
68
     *
69
     * @param string $profile Profile
70
     * @param string $name Name
71
     */
72 50
    public function __construct($profile, $name)
73
    {
74 50
        $this->immutableProfile = strval($profile);
75 50
        $this->immutableName = strval($name);
76 50
    }
77
78
    /**
79
     * Property getter
80
     *
81
     * @param string $name Property name
82
     * @return string Property value
83
     * @throws OutOfBoundsException If the requested IRI property is unknown
84
     */
85 49
    public function __get($name)
86
    {
87 49
        if ($name == 'profile') {
88 34
            return $this->immutableProfile;
89
        }
90 49
        if ($name == 'name') {
91 49
            return $this->immutableName;
92
        }
93
94 1
        throw new OutOfBoundsException(
95 1
            sprintf(OutOfBoundsException::UNKNOWN_IRI_PROPERTY_NAME_STR, $name),
96 1
            OutOfBoundsException::UNKNOWN_IRI_PROPERTY_NAME
97
        );
98
    }
99
100
    /**
101
     * Check the existence of a property
102
     *
103
     * @param string $name Property name
104
     * @return bool Property exists
105
     */
106 32
    public function __isset($name)
107
    {
108 32
        return ($name == 'profile') || ($name == 'name');
109
    }
110
111
    /**
112
     * Property setter
113
     *
114
     * @param string $name Property name
115
     * @param mixed $value Property value
116
     * @throws ErrorException If a property should be set
117
     */
118 1
    function __set($name, $value)
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
Comprehensibility Best Practice introduced by
It is recommend to declare an explicit visibility for __set.

Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed.

If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with private, and only raise it to protected if a sub-class needs to have access, or public if an external class needs access.

Loading history...
119
    {
120 1
        throw new ErrorException(ErrorException::IMMUTABLE_IRI_STR, ErrorException::IMMUTABLE_IRI);
121
    }
122
123
    /**
124
     * Serialize the IRI
125
     *
126
     * @return string Serialized IRI
127
     */
128 31
    function __toString()
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
Comprehensibility Best Practice introduced by
It is recommend to declare an explicit visibility for __toString.

Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed.

If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with private, and only raise it to protected if a sub-class needs to have access, or public if an external class needs access.

Loading history...
129
    {
130 31
        return $this->profile.$this->name;
131
    }
132
}
133