PHPUnit_Framework_Constraint_Count

class PHPUnit_Framework_Constraint_Count extends PHPUnit_Framework_Constraint (View source)

Properties

protected $exporter from PHPUnit_Framework_Constraint
protected int $expectedCount

Methods

__construct(int $expected)

No description

mixed
evaluate(mixed $other, string $description = '', bool $returnResult = false)

Evaluates the constraint for parameter $other

from PHPUnit_Framework_Constraint
bool
matches(mixed $other)

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

int
count()

Counts the number of constraint elements.

from PHPUnit_Framework_Constraint
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)

Throws an exception for the given compared value and test description

from PHPUnit_Framework_Constraint
string
additionalFailureDescription(mixed $other)

Return additional failure description where needed

from PHPUnit_Framework_Constraint
string
failureDescription(mixed $other)

Returns the description of the failure.

bool
getCountOf(mixed $other)

No description

int
getCountOfGenerator(Generator $generator)

Returns the total number of iterations from a generator.

string
toString()

No description

Details

at line 21
__construct(int $expected)

Parameters

int $expected

in PHPUnit_Framework_Constraint at line 43
mixed evaluate(mixed $other, string $description = '', bool $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

Return Value

mixed

Exceptions

PHPUnit_Framework_ExpectationFailedException

at line 35
protected bool matches(mixed $other)

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

Parameters

mixed $other Value or object to evaluate.

Return Value

bool

in PHPUnit_Framework_Constraint at line 80
int count()

Counts the number of constraint elements.

Return Value

int

in PHPUnit_Framework_Constraint at line 94
protected fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)

Throws an exception for the given compared value and test description

Parameters

mixed $other Evaluated value or object.
string $description Additional information about the test
ComparisonFailure $comparisonFailure

Exceptions

PHPUnit_Framework_ExpectationFailedException

in PHPUnit_Framework_Constraint at line 127
protected string additionalFailureDescription(mixed $other)

Return additional failure description where needed

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

Parameters

mixed $other Evaluated value or object.

Return Value

string

at line 103
protected string failureDescription(mixed $other)

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.

Return Value

string

at line 45
protected bool getCountOf(mixed $other)

Parameters

mixed $other

Return Value

bool

at line 84
protected int getCountOfGenerator(Generator $generator)

Returns the total number of iterations from a generator.

This will fully exhaust the generator.

Parameters

Generator $generator

Return Value

int

at line 115
string toString()

Return Value

string