class PHPUnit_Framework_Constraint_ArraySubset in Zircon Profile 8

Constraint that asserts that the array it is evaluated for has a specified subset.

Uses array_replace_recursive() to check if a key value subset is part of the subject array.

@since Class available since Release 4.4.0

Hierarchy

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

File

vendor/phpunit/phpunit/src/Framework/Constraint/ArraySubset.php, line 19

class PHPUnit_Framework_Constraint_ArraySubset extends PHPUnit_Framework_Constraint {

  /**
   * @var array|ArrayAccess
   */
  protected $subset;

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

  /**
   * @param array|ArrayAccess $subset
   * @param bool              $strict Check for object identity
   */
  public function __construct($subset, $strict = false) {
    parent::__construct();
    $this->strict = $strict;
    $this->subset = $subset;
  }

  /**
   * Evaluates the constraint for parameter $other. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  array|ArrayAccess $other Array or ArrayAccess object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    $patched = array_replace_recursive($other, $this->subset);
    if ($this->strict) {
      return $other === $patched;
    }
    else {
      return $other == $patched;
    }
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'has the subset ' . $this->exporter
      ->export($this->subset);
  }

  /**
   * 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 'an array ' . $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_ArraySubset::$strict	protected	property
PHPUnit_Framework_Constraint_ArraySubset::$subset	protected	property
PHPUnit_Framework_Constraint_ArraySubset::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_ArraySubset::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_ArraySubset::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_ArraySubset::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct