RequireDefinedObjectType::check()   A
last analyzed

Complexity

Conditions 3
Paths 3

Size

Total Lines 13
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
c 2
b 1
f 0
dl 0
loc 13
rs 9.4285
cc 3
eloc 6
nc 3
nop 3
1
<?php
2
3
/**
4
 * Copyright (c) 2015-present Ganbaro Digital Ltd
5
 * All rights reserved.
6
 *
7
 * Redistribution and use in source and binary forms, with or without
8
 * modification, are permitted provided that the following conditions
9
 * are met:
10
 *
11
 *   * Redistributions of source code must retain the above copyright
12
 *     notice, this list of conditions and the following disclaimer.
13
 *
14
 *   * Redistributions in binary form must reproduce the above copyright
15
 *     notice, this list of conditions and the following disclaimer in
16
 *     the documentation and/or other materials provided with the
17
 *     distribution.
18
 *
19
 *   * Neither the names of the copyright holders nor the names of his
20
 *     contributors may be used to endorse or promote products derived
21
 *     from this software without specific prior written permission.
22
 *
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34
 * POSSIBILITY OF SUCH DAMAGE.
35
 *
36
 * @category  Libraries
37
 * @package   Reflection/Requirements
38
 * @author    Stuart Herbert <[email protected]>
39
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
40
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
41
 * @link      http://code.ganbarodigital.com/php-reflection
42
 */
43
44
namespace GanbaroDigital\Reflection\Requirements;
45
46
use GanbaroDigital\Reflection\Exceptions\E4xx_NoSuchClass;
47
use GanbaroDigital\Reflection\Exceptions\E4xx_UnsupportedType;
48
use GanbaroDigital\Reflection\Checks\IsDefinedObjectType;
49
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;
50
51
class RequireDefinedObjectType
52
{
53
    /**
54
     * throws exceptions if $item is not a PHP class or interface that exists
55
     *
56
     * this is a wrapper around our IsDefinedObjectType check
57
     *
58
     * @param  mixed $item
59
     *         the container to check
60
     * @param  string $eNoSuchClass
61
     *         the exception to throw if $item isn't a valid PHP class
62
     * @param  string $eUnsupportedType
63
     *         the exception to throw if $item isn't something that we can check
64
     * @return void
65
     */
66
    public static function check($item, $eNoSuchClass = E4xx_NoSuchClass::class, $eUnsupportedType = E4xx_UnsupportedType::class)
67
    {
68
        RequireStringy::check($item, $eUnsupportedType);
69
70
        if (trait_exists($item)) {
71
            throw new $eUnsupportedType(SimpleType::from($item));
72
        }
73
74
        // make sure we have a PHP class that exists
75
        if (!IsDefinedObjectType::check($item)) {
76
            throw new $eNoSuchClass($item);
77
        }
78
    }
79
80
    /**
81
     * throws exceptions if $item is not a PHP class or interface that exists
82
     *
83
     * this is a wrapper around our IsDefinedObjectType check
84
     *
85
     * @param  mixed $item
86
     *         the container to check
87
     * @param  string $eNoSuchClass
88
     *         the exception to throw if $item isn't a valid PHP class
89
     * @param  string $eUnsupportedType
90
     *         the exception to throw if $item isn't something that we can check
91
     * @return void
92
     */
93
    public function __invoke($item, $eNoSuchClass = E4xx_NoSuchClass::class, $eUnsupportedType = E4xx_UnsupportedType::class)
94
    {
95
        self::check($item, $eNoSuchClass, $eUnsupportedType);
96
    }
97
}