File: TypeSafeMatcher.php

package info (click to toggle)
php-hamcrest 2.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,168 kB
  • sloc: php: 6,353; makefile: 14; sh: 9
file content (107 lines) | stat: -rw-r--r-- 2,918 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?php
namespace Hamcrest;

/**
 * Convenient base class for Matchers that require a value of a specific type.
 * This simply checks the type.
 *
 * While it may seem a useless exercise to have this in PHP, objects cannot
 * be cast to certain data types such as numerics (or even strings if
 * __toString() has not be defined).
 */

abstract class TypeSafeMatcher extends BaseMatcher
{

    /* Types that PHP can compare against */
    const TYPE_ANY = 0;
    const TYPE_STRING = 1;
    const TYPE_NUMERIC = 2;
    const TYPE_ARRAY = 3;
    const TYPE_OBJECT = 4;
    const TYPE_RESOURCE = 5;
    const TYPE_BOOLEAN = 6;

    /**
     * The type that is required for a safe comparison
     *
     * @var int
     */
    private $_expectedType;

    /**
     * The subtype (e.g. class for objects) that is required
     *
     * @var string
     */
    private $_expectedSubtype;

    public function __construct($expectedType, $expectedSubtype = null)
    {
        $this->_expectedType = $expectedType;
        $this->_expectedSubtype = $expectedSubtype;
    }

    final public function matches($item)
    {
        return $this->_isSafeType($item) && $this->matchesSafely($item);
    }

    final public function describeMismatch($item, Description $mismatchDescription)
    {
        if (!$this->_isSafeType($item)) {
            parent::describeMismatch($item, $mismatchDescription);
        } else {
            $this->describeMismatchSafely($item, $mismatchDescription);
        }
    }

    // -- Protected Methods

    /**
     * The item will already have been checked for the specific type and subtype.
     */
    abstract protected function matchesSafely($item);

    /**
     * The item will already have been checked for the specific type and subtype.
     */
    abstract protected function describeMismatchSafely($item, Description $mismatchDescription);

    // -- Private Methods

    private function _isSafeType($value)
    {
        switch ($this->_expectedType) {

            case self::TYPE_ANY:
                return true;

            case self::TYPE_STRING:
                return is_string($value) || is_numeric($value);

            case self::TYPE_NUMERIC:
                return is_numeric($value) || is_string($value);

            case self::TYPE_ARRAY:
                return is_array($value);

            case self::TYPE_OBJECT:
                return is_object($value)
                        && ($this->_expectedSubtype === null
                                || $value instanceof $this->_expectedSubtype);

            case self::TYPE_RESOURCE:
                return is_resource($value)
                        && ($this->_expectedSubtype === null
                                || get_resource_type($value) == $this->_expectedSubtype);

            case self::TYPE_BOOLEAN:
                return true;

            default:
                return true;

        }
    }
}