← Back to branch summary

~ubuntu-branches/ubuntu/natty/phpunit/natty

« back to all changes in this revision

Viewing changes to PHPUnit-3.4.14/PHPUnit/Framework/Constraint/IsInstanceOf.php

  • Committer: Package Import Robot
  • Author(s): Ivan Borzenkov
  • Date: 2010-12-11 18:19:39 UTC
  • mfrom: (0.11.1) (1.5.3) (12.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20101211181939-8650nbu08hf2z9v1
Tags: 3.5.5-2
fix doc-base-file-references-missing-file

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHPUnit-3.4.14/PHPUnit/Framework/Constraint/IsInstanceOf.php
1
 
<?php
2
 
/**
3
 
 * PHPUnit
4
 
 *
5
 
 * Copyright (c) 2002-2010, Sebastian Bergmann <sb@sebastian-bergmann.de>.
6
 
 * All rights reserved.
7
 
 *
8
 
 * Redistribution and use in source and binary forms, with or without
9
 
 * modification, are permitted provided that the following conditions
10
 
 * are met:
11
 
 *
12
 
 *   * Redistributions of source code must retain the above copyright
13
 
 *     notice, this list of conditions and the following disclaimer.
14
 
 *
15
 
 *   * Redistributions in binary form must reproduce the above copyright
16
 
 *     notice, this list of conditions and the following disclaimer in
17
 
 *     the documentation and/or other materials provided with the
18
 
 *     distribution.
19
 
 *
20
 
 *   * Neither the name of Sebastian Bergmann nor the names of his
21
 
 *     contributors may be used to endorse or promote products derived
22
 
 *     from this software without specific prior written permission.
23
 
 *
24
 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25
 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26
 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27
 
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28
 
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29
 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30
 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31
 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32
 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33
 
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34
 
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35
 
 * POSSIBILITY OF SUCH DAMAGE.
36
 
 *
37
 
 * @category   Testing
38
 
 * @package    PHPUnit
39
 
 * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
40
 
 * @copyright  2002-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
41
 
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
42
 
 * @link       http://www.phpunit.de/
43
 
 * @since      File available since Release 3.0.0
44
 
 */
45
 
 
46
 
require_once 'PHPUnit/Framework.php';
47
 
require_once 'PHPUnit/Util/Filter.php';
48
 
require_once 'PHPUnit/Util/Type.php';
49
 
 
50
 
PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
51
 
 
52
 
/**
53
 
 * Constraint that asserts that the object it is evaluated for is an instance
54
 
 * of a given class.
55
 
 *
56
 
 * The expected class name is passed in the constructor.
57
 
 *
58
 
 * @category   Testing
59
 
 * @package    PHPUnit
60
 
 * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
61
 
 * @copyright  2002-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
62
 
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
63
 
 * @version    Release: 3.4.14
64
 
 * @link       http://www.phpunit.de/
65
 
 * @since      Class available since Release 3.0.0
66
 
 */
67
 
class PHPUnit_Framework_Constraint_IsInstanceOf extends PHPUnit_Framework_Constraint
68
 
{
69
 
    /**
70
 
     * @var string
71
 
     */
72
 
    protected $className;
73
 
 
74
 
    /**
75
 
     * @param string $className
76
 
     */
77
 
    public function __construct($className)
78
 
    {
79
 
        $this->className = $className;
80
 
    }
81
 
 
82
 
    /**
83
 
     * Evaluates the constraint for parameter $other. Returns TRUE if the
84
 
     * constraint is met, FALSE otherwise.
85
 
     *
86
 
     * @param mixed $other Value or object to evaluate.
87
 
     * @return bool
88
 
     */
89
 
    public function evaluate($other)
90
 
    {
91
 
        return ($other instanceof $this->className);
92
 
    }
93
 
 
94
 
    /**
95
 
     * Creates the appropriate exception for the constraint which can be caught
96
 
     * by the unit test system. This can be called if a call to evaluate()
97
 
     * fails.
98
 
     *
99
 
     * @param   mixed   $other The value passed to evaluate() which failed the
100
 
     *                         constraint check.
101
 
     * @param   string  $description A string with extra description of what was
102
 
     *                               going on while the evaluation failed.
103
 
     * @param   boolean $not Flag to indicate negation.
104
 
     * @throws  PHPUnit_Framework_ExpectationFailedException
105
 
     */
106
 
    public function fail($other, $description, $not = FALSE)
107
 
    {
108
 
        throw new PHPUnit_Framework_ExpectationFailedException(
109
 
          sprintf(
110
 
            '%sFailed asserting that %s is %san instance of class "%s".',
111
 
 
112
 
            !empty($description) ? $description . "\n" : '',
113
 
            PHPUnit_Util_Type::toString($other, TRUE),
114
 
            $not ? 'not ' : '',
115
 
            $this->className
116
 
          ),
117
 
          NULL
118
 
        );
119
 
    }
120
 
 
121
 
    /**
122
 
     * Returns a string representation of the constraint.
123
 
     *
124
 
     * @return string
125
 
     */
126
 
    public function toString()
127
 
    {
128
 
        return sprintf(
129
 
          'is instance of class "%s"',
130
 
 
131
 
          $this->className
132
 
        );
133
 
    }
134
 
}
135
 
?>
 
 
b'\\ No newline at end of file'