Documentation

PHPUnit_Framework_Constraint_Count extends PHPUnit_Framework_Constraint
in package

Abstract base class for constraints which can be applied to any value.

Tags
since

Class available since Release 3.6.0

Table of Contents

$expectedCount  : int
$exporter  : mixed
__construct()  : mixed
count()  : int
Counts the number of constraint elements.
evaluate()  : mixed
Evaluates the constraint for parameter $other
toString()  : string
additionalFailureDescription()  : string
Return additional failure description where needed
fail()  : mixed
Throws an exception for the given compared value and test description
failureDescription()  : string
Returns the description of the failure
getCountOf()  : bool
matches()  : bool
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.

Properties

$expectedCount

protected int $expectedCount = 0

Methods

__construct()

public __construct(int $expected) : mixed
Parameters
$expected : int
Return values
mixed

count()

Counts the number of constraint elements.

public count() : int
Tags
since

Method available since Release 3.4.0

Return values
int

evaluate()

Evaluates the constraint for parameter $other

public evaluate(mixed $other[, string $description = '' ][, bool $returnResult = false ]) : mixed

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
$other : mixed

Value or object to evaluate.

$description : string = ''

Additional information about the test

$returnResult : bool = false

Whether to return a result or throw an exception

Tags
throws
PHPUnit_Framework_ExpectationFailedException
Return values
mixed

toString()

public toString() : string
Return values
string

additionalFailureDescription()

Return additional failure description where needed

protected additionalFailureDescription(mixed $other) : string

The function can be overridden to provide additional failure information like a diff

Parameters
$other : mixed

Evaluated value or object.

Return values
string

failureDescription()

Returns the description of the failure

protected failureDescription(mixed $other) : string

The beginning of failure messages is "Failed asserting that" in most cases. This method should return the second part of that sentence.

Parameters
$other : mixed

Evaluated value or object.

Return values
string

getCountOf()

protected getCountOf(mixed $other) : bool
Parameters
$other : mixed
Return values
bool

matches()

Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.

protected matches(mixed $other) : bool
Parameters
$other : mixed
Return values
bool

Search results