Completed
Push — master ( 2d80b2...8a71ed )
by Joschi
03:21
created

DomainPropertiesTrait::getDomain()   A

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 0
Metric Value
cc 1
eloc 2
c 0
b 0
f 0
nc 1
nop 1
dl 0
loc 4
ccs 2
cts 2
cp 1
crap 1
rs 10
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\ObjectInterface;
40
use Apparat\Object\Domain\Model\Properties\AbstractDomainProperties;
41
use Apparat\Object\Domain\Model\Properties\GenericPropertiesInterface;
42
43
/**
44
 * Domain properties trait
45
 *
46
 * @package Apparat\Object
47
 * @subpackage Apparat\Object\Domain
48
 * @property array $collectionStates
49
 */
50
trait DomainPropertiesTrait
51
{
52
    /**
53
     * Domain properties
54
     *
55
     * @var GenericPropertiesInterface
56
     */
57
    protected $domainProperties;
58
    /**
59
     * Domain property collection class
60
     *
61
     * @var string
62
     */
63
    protected $domainPropertyCClass = AbstractDomainProperties::class;
64
65
    /**
66
     * Get a domain property value
67
     *
68
     * Multi-level properties might be traversed by property name paths separated with colons (":").
69
     *
70
     * @param string $property Property name
71
     * @return mixed Property value
72
     */
73 5
    public function getDomain($property)
74
    {
75 5
        return $this->domainProperties->getProperty($property);
76
    }
77
78
    /**
79
     * Set a domain property value
80
     *
81
     * @param string $property Property name
82
     * @param mixed $value Property value
83
     * @return ObjectInterface Self reference
84
     */
85 4
    public function setDomain($property, $value)
86
    {
87 4
        $this->setDomainProperties($this->domainProperties->setProperty($property, $value));
88 4
        return $this;
89
    }
90
91
    /**
92
     * Set the domain properties collection
93
     *
94
     * @param GenericPropertiesInterface $domainProperties Domain property collection
95
     * @param bool $overwrite Overwrite the existing collection (if present)
96
     */
97 38
    protected function setDomainProperties(GenericPropertiesInterface $domainProperties, $overwrite = false)
98
    {
99 38
        $this->domainProperties = $domainProperties;
100 38
        $domainPropsState = spl_object_hash($this->domainProperties);
101
102
        // If the domain property collection state has changed
103 38
        if (!$overwrite
104 38
            && !empty($this->collectionStates[AbstractDomainProperties::COLLECTION])
105 38
            && ($domainPropsState !== $this->collectionStates[AbstractDomainProperties::COLLECTION])
106
        ) {
107
            // Flag this object as mutated
108 4
            $this->setMutatedState();
109
        }
110
111 38
        $this->collectionStates[AbstractDomainProperties::COLLECTION] = $domainPropsState;
112 38
    }
113
114
    /**
115
     * Set the object state to mutated
116
     */
117
    abstract protected function setMutatedState();
118
}
119