Completed
Push — master ( 844a18...827038 )
by Joschi
02:54
created

Id::isProvisional()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 0
crap 1
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;
38
39
use Apparat\Object\Domain\Contract\SerializablePropertyInterface;
40
41
/**
42
 * Object ID
43
 *
44
 * @package Apparat\Object
45
 * @subpackage Apparat\Object\Domain
46
 */
47
class Id implements SerializablePropertyInterface
48
{
49
    /**
50
     * Object ID
51
     *
52
     * @var int
53
     */
54
    protected $uid = null;
55
    /**
56
     * Provisional ID
57
     *
58
     * @var int
59
     */
60
    const PROVISIONAL = 0;
61
62
    /**
63
     * ID constructor
64
     *
65
     * @param int $uid Object ID
66
     */
67 47
    public function __construct($uid)
68
    {
69
        // If the ID is invalid
70 47
        if (!is_int($uid) || ($uid < self::PROVISIONAL)) {
71 1
            throw new InvalidArgumentException(
72 1
                sprintf('Invalid object ID "%s"', $uid),
73
                InvalidArgumentException::INVALID_OBJECT_ID
74 1
            );
75
        }
76
77 46
        $this->uid = $uid;
78 46
    }
79
80
    /**
81
     * Unserialize the string representation of this property
82
     *
83
     * @param string $str Serialized property
84
     * @return Id ID property
85
     */
86 7
    public static function unserialize($str)
87
    {
88 7
        return new static(intval($str));
89
    }
90
91
    /**
92
     * Serialize the property
93
     *
94
     * @return mixed Property serialization
95
     */
96 2
    public function serialize()
97
    {
98 2
        return $this->getId();
99
    }
100
101
    /**
102
     * Return the object ID
103
     *
104
     * @return int Object ID
105
     */
106 24
    public function getId()
107
    {
108 24
        return $this->uid;
109
    }
110
111
    /**
112
     * Test if this ID is provisional
113
     *
114
     * @return bool Provisional ID
115
     */
116 8
    public function isProvisional() {
117 8
        return $this->uid === self::PROVISIONAL;
118
    }
119
}
120