tests/PHPUnit/PHPUnit/Framework/Constraint/FileExists.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 checks if the file(name) that it is evaluated for exists.
  48  *
  49  * The file path to check is passed as $other in evaluate().
  50  *
  51  * @package    PHPUnit
  52  * @subpackage Framework_Constraint
  53  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  54  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 3.5.13
  57  * @link       http://www.phpunit.de/
  58  * @since      Class available since Release 3.0.0
  59  */
  60 class PHPUnit_Framework_Constraint_FileExists extends PHPUnit_Framework_Constraint
  61 {
  62     /**
  63      * Evaluates the constraint for parameter $other. Returns TRUE if the
  64      * constraint is met, FALSE otherwise.
  65      *
  66      * @param mixed $other Value or object to evaluate.
  67      * @return bool
  68      */
  69     public function evaluate($other)
  70     {
  71         return file_exists($other);
  72     }
  73
  74     /**
  75      * @param   mixed   $other The value passed to evaluate() which failed the
  76      *                         constraint check.
  77      * @param   string  $description A string with extra description of what was
  78      *                               going on while the evaluation failed.
  79      * @param   boolean $not Flag to indicate negation.
  80      * @throws  PHPUnit_Framework_ExpectationFailedException
  81      */
  82     public function fail($other, $description, $not = FALSE)
  83     {
  84         $failureDescription = sprintf(
  85           'Failed asserting that file "%s" exists.',
  86
  87            $other
  88         );
  89
  90         if ($not) {
  91             $failureDescription = self::negate($failureDescription);
  92         }
  93
  94         if (!empty($description)) {
  95             $failureDescription = $description . "\n" . $failureDescription;
  96         }
  97
  98         throw new PHPUnit_Framework_ExpectationFailedException(
  99           $failureDescription
 100         );
 101     }
 102
 103     /**
 104      * Returns a string representation of the constraint.
 105      *
 106      * @return string
 107      */
 108     public function toString()
 109     {
 110         return 'file exists';
 111     }
 112 }