tests/PHPUnit/Framework/Constraint/IsInstanceOf.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, 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     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50 require_once 'PHPUnit/Util/Type.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Constraint that asserts that the object it is evaluated for is an instance
  56  * of a given class.
  57  *
  58  * The expected class name is passed in the constructor.
  59  *
  60  * @category   Testing
  61  * @package    PHPUnit
  62  * @author     Jan Borsodi <jb@ez.no>
  63  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  64  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  65  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  66  * @version    Release: 3.3.17
  67  * @link       http://www.phpunit.de/
  68  * @since      Class available since Release 3.0.0
  69  */
  70 class PHPUnit_Framework_Constraint_IsInstanceOf extends PHPUnit_Framework_Constraint
  71 {
  72     protected $className;
  73
  74     public function __construct($className)
  75     {
  76         $this->className = $className;
  77     }
  78
  79     /**
  80      * Evaluates the constraint for parameter $other. Returns TRUE if the
  81      * constraint is met, FALSE otherwise.
  82      *
  83      * @param mixed $other Value or object to evaluate.
  84      * @return bool
  85      */
  86     public function evaluate($other)
  87     {
  88         return ($other instanceof $this->className);
  89     }
  90
  91     /**
  92      * Creates the appropriate exception for the constraint which can be caught
  93      * by the unit test system. This can be called if a call to evaluate() fails.
  94      *
  95      * @param   mixed   $other The value passed to evaluate() which failed the
  96      *                         constraint check.
  97      * @param   string  $description A string with extra description of what was
  98      *                               going on while the evaluation failed.
  99      * @param   boolean $not Flag to indicate negation.
 100      * @throws  PHPUnit_Framework_ExpectationFailedException
 101      */
 102     public function fail($other, $description, $not = FALSE)
 103     {
 104         throw new PHPUnit_Framework_ExpectationFailedException(
 105           sprintf(
 106             '%sFailed asserting that %s is %san instance of class "%s".',
 107
 108             !empty($description) ? $description . "\n" : '',
 109             PHPUnit_Util_Type::toString($other, TRUE),
 110             $not ? 'not ' : '',
 111             $this->className
 112           ),
 113           NULL
 114         );
 115     }
 116
 117     /**
 118      * Returns a string representation of the constraint.
 119      *
 120      * @return string
 121      */
 122     public function toString()
 123     {
 124         return sprintf(
 125           'is instance of class "%s"',
 126
 127           $this->className
 128         );
 129     }
 130 }
 131 ?>