tests/PHPUnit/PHPUnit/Framework/Constraint/Attribute.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.1.0
  44  */
  45
  46 /**
  47  *
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_Constraint
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.1.0
  57  */
  58
  59 class PHPUnit_Framework_Constraint_Attribute extends PHPUnit_Framework_Constraint
  60 {
  61     /**
  62      * @var string
  63      */
  64     protected $attributeName;
  65
  66     /**
  67      * @var PHPUnit_Framework_Constraint
  68      */
  69     protected $constraint;
  70
  71     /**
  72      * @param PHPUnit_Framework_Constraint $constraint
  73      * @param string                       $attributeName
  74      */
  75     public function __construct(PHPUnit_Framework_Constraint $constraint, $attributeName)
  76     {
  77         $this->attributeName = $attributeName;
  78         $this->constraint    = $constraint;
  79     }
  80
  81     /**
  82      * Evaluates the constraint for parameter $other. Returns TRUE if the
  83      * constraint is met, FALSE otherwise.
  84      *
  85      * @param mixed $other Value or object to evaluate.
  86      * @return bool
  87      */
  88     public function evaluate($other)
  89     {
  90         return $this->constraint->evaluate(
  91           PHPUnit_Framework_Assert::readAttribute(
  92             $other, $this->attributeName
  93           )
  94         );
  95     }
  96
  97     /**
  98      * @param   mixed   $other The value passed to evaluate() which failed the
  99      *                         constraint check.
 100      * @param   string  $description A string with extra description of what was
 101      *                               going on while the evaluation failed.
 102      * @param   boolean $not Flag to indicate negation.
 103      * @throws  PHPUnit_Framework_ExpectationFailedException
 104      */
 105     public function fail($other, $description, $not = FALSE)
 106     {
 107         parent::fail(
 108           PHPUnit_Framework_Assert::readAttribute(
 109             $other, $this->attributeName
 110           ),
 111           $description,
 112           $not
 113         );
 114     }
 115
 116     /**
 117      * Returns a string representation of the constraint.
 118      *
 119      * @return string
 120      */
 121     public function toString()
 122     {
 123         return 'attribute "' . $this->attributeName . '" ' .
 124                $this->constraint->toString();
 125     }
 126
 127     /**
 128      * Counts the number of constraint elements.
 129      *
 130      * @return integer
 131      * @since  Method available since Release 3.4.0
 132      */
 133     public function count()
 134     {
 135         return count($this->constraint);
 136     }
 137
 138     /**
 139      * @since Method available since Release 3.4.0
 140      */
 141     protected function customFailureDescription($other, $description, $not)
 142     {
 143         return sprintf(
 144           'Failed asserting that %s.',
 145
 146            $this->toString()
 147         );
 148     }
 149 }