1. class
  2. PHPUnit
  3. \
  4. Framework
  5. \
  6. Constraint
  7. \
  8. Attribute

Attribute

class Attribute extends Composite (View source)

Properties

protected $exporter from Constraint
protected Constraint $innerConstraint from Composite
protected string $attributeName

Methods

__construct(Constraint $constraint, string $attributeName)

No description

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

Evaluates the constraint for parameter $other

bool
matches(mixed $other)

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

from Constraint
int
count()

Counts the number of constraint elements.

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

Throws an exception for the given compared value and test description

from Constraint
string
additionalFailureDescription(mixed $other)

Return additional failure description where needed

from Constraint
string
failureDescription(mixed $other)

Returns the description of the failure

string
toString()

Returns a string representation of the constraint.

Details

at line 26
__construct(Constraint $constraint, string $attributeName)

Parameters

Constraint $constraint
string $attributeName

at line 51
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

ExpectationFailedException

in Constraint at line 76
protected bool matches(mixed $other)

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

This method can be overridden to implement the evaluation algorithm.

Parameters

mixed $other Value or object to evaluate.

Return Value

bool

in Composite at line 66
int count()

Counts the number of constraint elements.

Return Value

int

in Constraint at line 100
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

ExpectationFailedException

in Constraint at line 133
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 84
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 68
string toString()

Returns a string representation of the constraint.

Return Value

string