tests/PHPUnit/PHPUnit/Framework/Constraint/Composite.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     Bernhard Schussek <bschussek@2bepublished.at>
  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.6.0
  44  */
  45
  46 /**
  47  *
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_Constraint
  51  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  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.6.3
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.6.0
  57  */
  58
  59 abstract class PHPUnit_Framework_Constraint_Composite extends PHPUnit_Framework_Constraint
  60 {
  61     /**
  62      * @var PHPUnit_Framework_Constraint
  63      */
  64     protected $innerConstraint;
  65
  66     /**
  67      * @param PHPUnit_Framework_Constraint $innerConstraint
  68      * @param string                       $attributeName
  69      */
  70     public function __construct(PHPUnit_Framework_Constraint $innerConstraint)
  71     {
  72         $this->innerConstraint = $innerConstraint;
  73     }
  74
  75     /**
  76      * Evaluates the constraint for parameter $other
  77      *
  78      * If $returnResult is set to FALSE (the default), an exception is thrown
  79      * in case of a failure. NULL is returned otherwise.
  80      *
  81      * If $returnResult is TRUE, the result of the evaluation is returned as
  82      * a boolean value instead: TRUE in case of success, FALSE in case of a
  83      * failure.
  84      *
  85      * @param  mixed $other Value or object to evaluate.
  86      * @param  string $description Additional information about the test
  87      * @param  bool $returnResult Whether to return a result or throw an exception
  88      * @return mixed
  89      * @throws PHPUnit_Framework_ExpectationFailedException
  90      */
  91     public function evaluate($other, $description = '', $returnResult = FALSE)
  92     {
  93         try {
  94             return $this->innerConstraint->evaluate(
  95               $other,
  96               $description,
  97               $returnResult
  98             );
  99         }
 100
 101         catch (PHPUnit_Framework_ExpectationFailedException $e) {
 102             $this->fail($other, $description);
 103         }
 104     }
 105
 106     /**
 107      * Counts the number of constraint elements.
 108      *
 109      * @return integer
 110      */
 111     public function count()
 112     {
 113         return count($this->innerConstraint);
 114     }
 115 }