class PHPUnit_Framework_Constraint_StringStartsWith

Constraint that asserts that the string it is evaluated for begins with a given prefix.

@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.4.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_StringStartsWith

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/StringStartsWith.php, line 60

View source
class PHPUnit_Framework_Constraint_StringStartsWith extends PHPUnit_Framework_Constraint {

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

  /**
   * @param string $prefix
   */
  public function __construct($prefix) {
    $this->prefix = $prefix;
  }

  /**
   * 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 strpos($other, $this->prefix) === 0;
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'starts with "' . $this->prefix . '"';
  }

}

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_StringStartsWith::$prefix protected property
PHPUnit_Framework_Constraint_StringStartsWith::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_StringStartsWith::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_StringStartsWith::__construct public function