class TraversableContains

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

Hierarchy

class \PHPUnit\Framework\Constraint\Constraint implements \Countable, \PHPUnit\Framework\SelfDescribing
- class \PHPUnit\Framework\Constraint\TraversableContains extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of TraversableContains

File

vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/TraversableContains.php, line 19

Namespace

PHPUnit\Framework\Constraint

View source

abstract class TraversableContains extends Constraint {
    private readonly mixed $value;
    public function __construct(mixed $value) {
        $this->value = $value;
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString(bool $exportObjects = false) : string {
        return 'contains ' . Exporter::export($this->value, $exportObjects);
    }
    
    /**
     * 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.
     */
    protected function failureDescription(mixed $other) : string {
        return sprintf('%s %s', is_array($other) ? 'an array' : 'a traversable', $this->toString(true));
    }
    protected function value() : mixed {
        return $this->value;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Constraint::additionalFailureDescription	protected	function	Return additional failure description where needed.		7
Constraint::count	public	function	Counts the number of constraint elements.		3
Constraint::evaluate	public	function	Evaluates the constraint for parameter $other.		7
Constraint::exporter	protected	function
Constraint::fail	protected	function	Throws an exception for the given compared value and test description.		1
Constraint::failureDescriptionInContext	protected	function	Returns the description of the failure when this constraint appears in context of an $operator expression.
Constraint::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.		70
Constraint::reduce	protected	function	Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.		2
Constraint::toStringInContext	protected	function	Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
Constraint::valueToTypeStringFragment	protected	function	@psalm-return non-empty-string
TraversableContains::$value	private	property
TraversableContains::failureDescription	protected	function	Returns the description of the failure.	Overrides Constraint::failureDescription
TraversableContains::toString	public	function	Returns a string representation of the constraint.	Overrides SelfDescribing::toString
TraversableContains::value	protected	function
TraversableContains::__construct	public	function