tests/PHPUnit/PHPUnit/Framework/Constraint/IsInstanceOf.php

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