class PHPUnit_Framework_Constraint_TraversableContains in Zircon Profile 8

Constraint that asserts that the Traversable it is applied to contains a given value.

@since Class available since Release 3.0.0

Hierarchy

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

File

vendor/phpunit/phpunit/src/Framework/Constraint/TraversableContains.php, line 17

class PHPUnit_Framework_Constraint_TraversableContains extends PHPUnit_Framework_Constraint {

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

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

  /**
   * @var mixed
   */
  protected $value;

  /**
   * @param  mixed                       $value
   * @param  bool                        $checkForObjectIdentity
   * @param  bool                        $checkForNonObjectIdentity
   * @throws PHPUnit_Framework_Exception
   */
  public function __construct($value, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false) {
    parent::__construct();
    if (!is_bool($checkForObjectIdentity)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'boolean');
    }
    if (!is_bool($checkForNonObjectIdentity)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(3, 'boolean');
    }
    $this->checkForObjectIdentity = $checkForObjectIdentity;
    $this->checkForNonObjectIdentity = $checkForNonObjectIdentity;
    $this->value = $value;
  }

  /**
   * 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 ($other instanceof SplObjectStorage) {
      return $other
        ->contains($this->value);
    }
    if (is_object($this->value)) {
      foreach ($other as $element) {
        if ($this->checkForObjectIdentity && $element === $this->value || !$this->checkForObjectIdentity && $element == $this->value) {
          return true;
        }
      }
    }
    else {
      foreach ($other as $element) {
        if ($this->checkForNonObjectIdentity && $element === $this->value || !$this->checkForNonObjectIdentity && $element == $this->value) {
          return true;
        }
      }
    }
    return false;
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    if (is_string($this->value) && strpos($this->value, "\n") !== false) {
      return 'contains "' . $this->value . '"';
    }
    else {
      return 'contains ' . $this->exporter
        ->export($this->value);
    }
  }

  /**
   * 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('%s %s', is_array($other) ? 'an array' : 'a traversable', $this
      ->toString());
  }

}

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_TraversableContains::$checkForNonObjectIdentity	protected	property
PHPUnit_Framework_Constraint_TraversableContains::$checkForObjectIdentity	protected	property
PHPUnit_Framework_Constraint_TraversableContains::$value	protected	property
PHPUnit_Framework_Constraint_TraversableContains::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_TraversableContains::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_TraversableContains::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_TraversableContains::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct