class PHPUnit_Framework_Constraint_StringContains

Constraint that asserts that the string it is evaluated for contains a given string.

Uses strpos() to find the position of the string in the input, if not found the evaluaton fails.

The sub-string is passed in the constructor.

@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_StringContains

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/StringContains.php, line 65

View source
class PHPUnit_Framework_Constraint_StringContains extends PHPUnit_Framework_Constraint {

  /**
   * @var string
   */
  protected $string;

  /**
   * @var boolean
   */
  protected $ignoreCase;

  /**
   * @param string  $string
   * @param boolean $ignoreCase
   */
  public function __construct($string, $ignoreCase = FALSE) {
    $this->string = $string;
    $this->ignoreCase = $ignoreCase;
  }

  /**
   * 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) {
    if ($this->ignoreCase) {
      return stripos($other, $this->string) !== FALSE;
    }
    else {
      return strpos($other, $this->string) !== FALSE;
    }
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    if ($this->ignoreCase) {
      $string = strtolower($this->string);
    }
    else {
      $string = $this->string;
    }
    return sprintf('contains "%s"', $string);
  }

}

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::failureDescription protected function Returns the description of the failure 15
PHPUnit_Framework_Constraint_StringContains::$ignoreCase protected property
PHPUnit_Framework_Constraint_StringContains::$string protected property
PHPUnit_Framework_Constraint_StringContains::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_StringContains::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_StringContains::__construct public function