class PHPUnit_Framework_Constraint_FileExists

Constraint that checks if the file(name) that it is evaluated for exists.

The file path to check is passed as $other in evaluate().

@package PHPUnit @subpackage Framework_Constraint @author Sebastian Bergmann <sebastian@phpunit.de> @author Bernhard Schussek <bschussek@2bepublished.at> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_FileExists

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/FileExists.php, line 61

View source
class PHPUnit_Framework_Constraint_FileExists extends PHPUnit_Framework_Constraint {

  /**
   * Evaluates the constraint for parameter $other. Returns TRUE if the
   * constraint is met, FALSE otherwise.
   *
   * @param mixed $other Value or object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    return file_exists($other);
  }

  /**
   * Returns the description of the failure
   *
   * The beginning of failure messages is "Failed asserting that" in most
   * cases. This method should return the second part of that sentence.
   *
   * @param  mixed $other Evaluated value or object.
   * @return string
   */
  protected function failureDescription($other) {
    return sprintf('file "%s" exists', $other);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'file exists';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Constraint::additionalFailureDescription protected function Return additional failure description where needed 1
PHPUnit_Framework_Constraint::count public function Counts the number of constraint elements. 6
PHPUnit_Framework_Constraint::evaluate public function Evaluates the constraint for parameter $other 9
PHPUnit_Framework_Constraint::fail protected function Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint_FileExists::failureDescription protected function Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_FileExists::matches protected function Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise. Overrides PHPUnit_Framework_Constraint::matches
PHPUnit_Framework_Constraint_FileExists::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString