class PHPUnit_Framework_Constraint_StringContains in Zircon Profile 8

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 evaluation fails.

The sub-string is passed in the constructor.

@since Class available since Release 3.0.0

Hierarchy

• class \PHPUnit_Framework_Constraint implements \Countable, PHPUnit_Framework_SelfDescribing
  • class \PHPUnit_Framework_Constraint_StringContains

File

vendor/phpunit/phpunit/src/Framework/Constraint/StringContains.php, line 22

class PHPUnit_Framework_Constraint_StringContains extends PHPUnit_Framework_Constraint {

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

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

  /**
   * @param string $string
   * @param bool   $ignoreCase
   */
  public function __construct($string, $ignoreCase = false) {
    parent::__construct();
    $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

Name	Modifiers	Type	Description	Overrides
PHPUnit_Framework_Constraint::$exporter	protected	property
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	17
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	Overrides PHPUnit_Framework_Constraint::__construct