Completed
Push — v2 ( ad2ba8...88b419 )
by Joschi
04:59
created

Item::getFormat()   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
dl 0
loc 4
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
/**
4
 * micrometa
5
 *
6
 * @category Jkphl
7
 * @package Jkphl\Micrometa
8
 * @subpackage Jkphl\Micrometa\Application\Item
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\Application\Item;
38
39
/**
40
 * Item
41
 *
42
 * @package Jkphl\Micrometa
43
 * @subpackage Jkphl\Micrometa\Application
44
 */
45
class Item extends \Jkphl\Micrometa\Domain\Item\Item implements ItemInterface
46
{
47
    /**
48
     * Parser format
49
     *
50
     * @var int
51
     */
52
    protected $format;
53
    /**
54
     * Item value
55
     *
56
     * @var string
57
     */
58
    protected $value;
59
    /**
60
     * Nested Items
61
     *
62
     * @var ItemInterface[]
63
     */
64
    protected $children;
65
66
    /**
67
     * Item constructor
68
     *
69
     * @param int $format Parser format
70
     * @param string|array $type Item type(s)
71
     * @param array[] $properties Item properties
72
     * @param ItemInterface[] $children Nested items
73
     * @param string|null $itemId Item id
74
     * @param string|null $value Item value
75
     */
76 8
    public function __construct(
77
        $format,
78
        $type,
79
        array $properties = [],
80
        array $children = [],
81
        $itemId = null,
82
        $value = null
83
    ) {
84 8
        $this->format = $format;
85 8
        parent::__construct($type, $properties, $itemId);
0 ignored issues
show
Bug introduced by
It seems like $type defined by parameter $type on line 78 can also be of type array; however, Jkphl\Micrometa\Domain\Item\Item::__construct() does only seem to accept string|object<stdClass>|...teger,object<stdClass>>, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
86 8
        $this->children = $children;
87 8
        $this->value = $value;
88 8
    }
89
90
    /**
91
     * Return the parser format
92
     *
93
     * @return int Parser format
94
     */
95 4
    public function getFormat()
96
    {
97 4
        return $this->format;
98
    }
99
100
    /**
101
     * Return the item value
102
     *
103
     * @return string Item value
104
     */
105
    public function getValue()
106
    {
107
        return $this->value;
108
    }
109
110
    /**
111
     * Return the nested children
112
     *
113
     * @return ItemInterface[] Nested children
114
     */
115 1
    public function getChildren()
116
    {
117 1
        return $this->children;
118
    }
119
}
120