PHPUnit_Framework_Constraint_Attribute Class Reference

Inheritance diagram for PHPUnit_Framework_Constraint_Attribute:

Collaboration diagram for PHPUnit_Framework_Constraint_Attribute:

Public Member Functions
	__construct (PHPUnit_Framework_Constraint $constraint, $attributeName)
	evaluate ($other, $description= '', $returnResult=false)
	toString ()
Public Member Functions inherited from PHPUnit_Framework_Constraint_Composite
	__construct (PHPUnit_Framework_Constraint $innerConstraint)
	evaluate ($other, $description= '', $returnResult=false)
	count ()
Public Member Functions inherited from PHPUnit_Framework_Constraint
	evaluate ($other, $description= '', $returnResult=false)
	count ()

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

Protected Attributes
	$attributeName
Protected Attributes inherited from PHPUnit_Framework_Constraint_Composite
	$innerConstraint
Protected Attributes inherited from PHPUnit_Framework_Constraint
	$exporter

Detailed Description

Since

Class available since Release 3.1.0

Constructor & Destructor Documentation

PHPUnit_Framework_Constraint_Attribute::__construct	(	PHPUnit_Framework_Constraint	$constraint,
			$attributeName
	)

Parameters

PHPUnit_Framework_Constraint	$constraint
string	$attributeName

Member Function Documentation

PHPUnit_Framework_Constraint_Attribute::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	$other	Value or object to evaluate.
string	$description	Additional information about the test
bool	$returnResult	Whether to return a result or throw an exception

Returns

mixed

Exceptions

PHPUnit_Framework_ExpectationFailedException

PHPUnit_Framework_Constraint_Attribute::failureDescription (   $other )

protected

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.

Parameters

mixed

$other

Evaluated value or object.

Returns

string

PHPUnit_Framework_Constraint_Attribute::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:

• /home/hwfunc/workspace/leonid/BlueSpiceDoc-composer/mediawiki-master/vendor/phpunit/phpunit/src/Framework/Constraint/Attribute.php