Completed
Push — master ( ca81b9...863650 )
by Joschi
03:44
created

RelationsTrait::addRelation()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 3
c 1
b 0
f 1
nc 1
nop 2
dl 0
loc 4
ccs 3
cts 3
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
use Apparat\Object\Domain\Model\Object\ObjectInterface;
39
use Apparat\Object\Domain\Model\Properties\Relations;
40
use Apparat\Object\Domain\Model\Relation\RelationInterface;
41
42
/**
43
 * Relations trait
44
 *
45
 * @package Apparat\Object
46
 * @subpackage Apparat\Object\Domain
47
 * @property array $collectionStates
48
 */
49
trait RelationsTrait
50
{
51
    /**
52
     * Object relations
53
     *
54
     * @var Relations
55
     */
56
    protected $relations;
57
58
    /**
59
     * Set the relations collection
60
     *
61
     * @param Relations $relations Relations collection
62
     * @param bool $overwrite Overwrite the existing collection (if present)
63
     */
64 19
    protected function setRelations(Relations $relations, $overwrite = false)
65
    {
66 19
        $this->relations = $relations;
67 19
        $relationsState = spl_object_hash($this->relations);
68
69
        // If the domain property collection state has changed
70 19
        if (!$overwrite
71 19
            && !empty($this->collectionStates[Relations::COLLECTION])
72 19
            && ($relationsState !== $this->collectionStates[Relations::COLLECTION])
73
        ) {
74
            // Flag this object as dirty
75 1
            $this->setDirtyState();
76
        }
77
78 19
        $this->collectionStates[Relations::COLLECTION] = $relationsState;
79 19
    }
80
81
    /**
82
     * Set the object state to dirty
83
     */
84
    abstract protected function setDirtyState();
85
86
    /**
87
     * Add an object relation
88
     *
89
     * @param string $relationType Relation type
90
     * @param string|RelationInterface $relation Serialized or instantiated object relation
91
     * @return ObjectInterface
92
     */
93 1
    public function addRelation($relationType, $relation) {
94 1
        $this->setRelations($this->relations->addRelation($relationType, $relation));
95 1
        return $this;
96
    }
97
98
    /**
99
     * Get all relations (optional: Of a particular type)
100
     *
101
     * @param string|null $relationType Optional: Relation type
102
     * @return array Object relations
103
     */
104
    public function getRelations($relationType = null) {
105
        return $this->relations->getRelations($relationType);
106
    }
107
}
108