Lggr
All Classes Namespaces Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
PHPUnit\Framework\Constraint\TraversableContainsOnly Class Reference
Inheritance diagram for PHPUnit\Framework\Constraint\TraversableContainsOnly:
Inheritance graph
[legend]
Collaboration diagram for PHPUnit\Framework\Constraint\TraversableContainsOnly:
Collaboration graph
[legend]

Public Member Functions

 __construct ($type, $isNativeType=true)
 
 evaluate ($other, $description='', $returnResult=false)
 
 toString ()
 
- Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
 count ()
 

Protected Attributes

 $constraint
 
 $type
 
- Protected Attributes inherited from PHPUnit\Framework\Constraint\Constraint
 $exporter
 

Additional Inherited Members

- Protected Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
 matches ($other)
 
 fail ($other, $description, ComparisonFailure $comparisonFailure=null)
 
 additionalFailureDescription ($other)
 
 failureDescription ($other)
 

Detailed Description

Constraint that asserts that the Traversable it is applied to contains only values of a given type.

Constructor & Destructor Documentation

◆ __construct()

PHPUnit\Framework\Constraint\TraversableContainsOnly::__construct (   $type,
  $isNativeType = true 
)
Parameters
string$type
bool$isNativeType

Member Function Documentation

◆ evaluate()

PHPUnit\Framework\Constraint\TraversableContainsOnly::evaluate (   $other,
  $description = '',
  $returnResult = false 
)

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.

Parameters
mixed$otherValue or object to evaluate.
string$descriptionAdditional information about the test
bool$returnResultWhether to return a result or throw an exception
Returns
mixed
Exceptions
ExpectationFailedException

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

◆ toString()

PHPUnit\Framework\Constraint\TraversableContainsOnly::toString ( )

Returns a string representation of the constraint.

Returns
string

Implements PHPUnit\Framework\SelfDescribing.


The documentation for this class was generated from the following file: