OneOfCollection::validate()   B
last analyzed

Complexity

Conditions 5
Paths 5

Size

Total Lines 29
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 29
rs 8.439
cc 5
eloc 15
nc 5
nop 0
1
<?php
2
/**
3
 * Copyright (c) 2014-2016 Ryan Parman.
4
 *
5
 * Permission is hereby granted, free of charge, to any person obtaining a copy
6
 * of this software and associated documentation files (the "Software"), to deal
7
 * in the Software without restriction, including without limitation the rights
8
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the Software is
10
 * furnished to do so, subject to the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be included in
13
 * all copies or substantial portions of the Software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
 * THE SOFTWARE.
22
 *
23
 * http://opensource.org/licenses/MIT
24
 */
25
26
namespace Skyzyx\StrongTypes;
27
28
use \UnexpectedValueException;
29
30
class OneOfCollection extends MapCollection
31
{
32
    /**************************************************************************/
33
    // ShapeInterface
34
35
    /**
36
     * {@inheritdoc}
37
     */
38
    public function validate()
39
    {
40
        parent::validate();
41
42
        if (!is_array($this->requireOneKey())) {
43
            throw new UnexpectedValueException(
44
                sprintf('The `requireOneKey()` method must return an indexed array.')
45
            );
46
        }
47
48
        $array_keys = array_keys($this->getValue());
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
49
        $required_keys = array_flip($this->requireOneKey());
50
51
        if (count($required_keys) === 0) {
52
            return true;
53
        }
54
55
        foreach ($array_keys as $key) {
56
            if (isset($required_keys[$key])) {
57
                return true;
58
            }
59
        }
60
61
        throw new UnexpectedValueException(
62
            sprintf('The collection did not contain any of the required fields: %s',
63
                implode(', ', $this->requireOneKey())
64
            )
65
        );
66
    }
67
68
    /**
69
     * Gets a list of keys where one or more are required, but not all.
70
     *
71
     * @return array A list of keys where one or more are required, but not all.
72
     */
73
    public function requireOneKey()
74
    {
75
        return [];
76
    }
77
}
78