class TraversableContainsOnly

@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\TraversableContainsOnly extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of TraversableContainsOnly

2 files declare their use of TraversableContainsOnly

Assert.php in vendor/phpunit/phpunit/src/Framework/Assert.php
Functions.php in vendor/phpunit/phpunit/src/Framework/Assert/Functions.php

File

vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/TraversableContainsOnly.php, line 18

Namespace

PHPUnit\Framework\Constraint

View source

final class TraversableContainsOnly extends Constraint {
    private Constraint $constraint;
    private readonly string $type;
    
    /**
     * @throws Exception
     */
    public function __construct(string $type, bool $isNativeType = true) {
        if ($isNativeType) {
            $this->constraint = new IsType($type);
        }
        else {
            $this->constraint = new IsInstanceOf($type);
        }
        $this->type = $type;
    }
    
    /**
     * Evaluates the constraint for parameter $other.
     *
     * If $returnResult is set to false (the default), an exception is thrown
     * in case of a failure. null is returned otherwise.
     *
     * If $returnResult is true, the result of the evaluation is returned as
     * a boolean value instead: true in case of success, false in case of a
     * failure.
     *
     * @throws ExpectationFailedException
     */
    public function evaluate(mixed $other, string $description = '', bool $returnResult = false) : bool {
        $success = true;
        foreach ($other as $item) {
            if (!$this->constraint
                ->evaluate($item, '', true)) {
                $success = false;
                break;
            }
        }
        if (!$success && !$returnResult) {
            $this->fail($other, $description);
        }
        return $success;
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString() : string {
        return 'contains only values of type "' . $this->type . '"';
    }

}

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::exporter	protected	function
Constraint::fail	protected	function	Throws an exception for the given compared value and test description.		1
Constraint::failureDescription	protected	function	Returns the description of the failure.		51
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
TraversableContainsOnly::$constraint	private	property
TraversableContainsOnly::$type	private	property
TraversableContainsOnly::evaluate	public	function	Evaluates the constraint for parameter $other.	Overrides Constraint::evaluate
TraversableContainsOnly::toString	public	function	Returns a string representation of the constraint.	Overrides SelfDescribing::toString
TraversableContainsOnly::__construct	public	function