Completed
Push — master ( 218245...88eef6 )
by Joschi
05:11
created

AbstractGenericProperties::getProperty()   B

Complexity

Conditions 4
Paths 4

Size

Total Lines 31
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 31
ccs 0
cts 15
cp 0
rs 8.5806
cc 4
eloc 16
nc 4
nop 1
crap 20
1
<?php
2
3
/**
4
 * apparat-object
5
 *
6
 * @category    Apparat
7
 * @package     Apparat\Object
8
 * @subpackage  Apparat\Object\Application
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)
0 ignored issues
show
Coding Style introduced by
Spaces must be used for alignment; tabs are not allowed
Loading history...
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\Properties;
38
39
use Apparat\Object\Domain\Model\Object\ObjectInterface;
40
41
/**
42
 * Abstract generic object properties collection
43
 *
44
 * @package Apparat\Object
45
 * @subpackage Apparat\Object\Application
46
 */
47
abstract class AbstractGenericProperties extends AbstractProperties implements GenericPropertiesInterface
48
{
49
    /**
50
     * Property data
51
     *
52
     * @var array
53
     */
54
    protected $_data = [];
55
56
    /**
57
     * Property collection constructor
58
     *
59
     * @param array $data Property data
60
     * @param ObjectInterface $object Owner object
61
     */
62 1
    public function __construct(array $data, ObjectInterface $object)
63
    {
64 1
        parent::__construct($data, $object);
65
66 1
        $this->_data = $data;
67 1
    }
68
69
    /**
70
     * Get a particular property value
71
     *
72
     * Multi-level properties might be traversed by property name paths separated with colons (":").
73
     *
74
     * @param string $property Property name
75
     * @return mixed Property value
76
     * @throws InvalidArgumentException If the property name is empty
77
     */
78
    public function getProperty($property)
79
    {
80
        $propertyPath = array_filter(array_map('trim', explode(self::PROPERTY_TRAVERSAL_SEPARATOR, $property)));
81
82
        // If the property traversal path is empty
83
        if (!count($propertyPath)) {
84
            throw new InvalidArgumentException('Empty property name', InvalidArgumentException::EMPTY_PROPERTY_NAME);
85
        }
86
87
        // Traverse the property tree
88
        $propertyPathTraversed = [];
89
        $data =& $this->_data;
90
        foreach ($propertyPath as $property) {
91
            $propertyPathTraversed[] = $property;
92
93
            // If the property name step is invalid
94
            if (!array_key_exists($property, $data)) {
95
                throw new InvalidArgumentException(
96
                    sprintf(
97
                        'Invalid property name "%s"',
98
                        implode(self::PROPERTY_TRAVERSAL_SEPARATOR, $propertyPathTraversed)
99
                    ),
100
                    InvalidArgumentException::INVALID_PROPERTY_NAME
101
                );
102
            }
103
104
            $data =& $data[$property];
105
        }
106
107
        return $data;
108
    }
109
}
110