BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
PHPUnit_Framework_Constraint_IsEqual Class Reference
Inheritance diagram for PHPUnit_Framework_Constraint_IsEqual:
Collaboration diagram for PHPUnit_Framework_Constraint_IsEqual:

Public Member Functions

 __construct ($value, $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
 
 evaluate ($other, $description= '', $returnResult=false)
 
 toString ()
 
- Public Member Functions inherited from PHPUnit_Framework_Constraint
 evaluate ($other, $description= '', $returnResult=false)
 
 count ()
 

Protected Attributes

 $value
 
 $delta = 0.0
 
 $maxDepth = 10
 
 $canonicalize = false
 
 $ignoreCase = false
 
 $lastFailure
 
- Protected Attributes inherited from PHPUnit_Framework_Constraint
 $exporter
 

Additional Inherited Members

- Protected Member Functions inherited from PHPUnit_Framework_Constraint
 matches ($other)
 
 fail ($other, $description, SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure=null)
 
 additionalFailureDescription ($other)
 
 failureDescription ($other)
 

Detailed Description

Constraint that checks if one value is equal to another.

Equality is checked with PHP's == operator, the operator is explained in detail at { http://www.php.net/manual/en/types.comparisons.php}. Two values are equal if they have the same value disregarding type.

The expected value is passed in the constructor.

Since
Class available since Release 3.0.0

Constructor & Destructor Documentation

PHPUnit_Framework_Constraint_IsEqual::__construct (   $value,
  $delta = 0.0,
  $maxDepth = 10,
  $canonicalize = false,
  $ignoreCase = false 
)
Parameters
mixed$value
float$delta
int$maxDepth
bool$canonicalize
bool$ignoreCase
Exceptions
PHPUnit_Framework_Exception

Member Function Documentation

PHPUnit_Framework_Constraint_IsEqual::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
PHPUnit_Framework_ExpectationFailedException
PHPUnit_Framework_Constraint_IsEqual::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: