UsesTrait
final class UsesTrait extends AbstractInheritanceConstraint
Constraint that accepts classes that extend given class.
Methods
Returns a string representation of the constraint.
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
Returns the description of the failure.
Returns short description of what we examine, e.g. 'implements interface'.
Returns short negated description of what we examine, e.g. 'does not implement interface'.
No description
Checks if $subject may be used as an argument to inheritance().
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
Returns the description of the failure when this constraint appears in context of an $operator expression.
Details
in
AbstractInheritanceConstraint at line 31
protected
__construct(string $expected)
Initializes the constraint.
in
AbstractInheritanceConstraint at line 36
final string
toString()
Returns a string representation of the constraint.
in
AbstractInheritanceConstraint at line 47
final bool
matches(mixed $other)
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
in
AbstractInheritanceConstraint at line 68
final 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.
at line 35
protected string
verb()
Returns short description of what we examine, e.g. 'implements interface'.
at line 40
protected string
negatedVerb()
Returns short negated description of what we examine, e.g. 'does not implement interface'.
at line 50
protected array
inheritance(string $class)
No description
at line 57
protected bool
supports(string $subject)
Checks if $subject may be used as an argument to inheritance().
in
AbstractInheritanceConstraint at line 112
final protected string
toStringInContext(Operator $operator, mixed $role)
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
The purpose of this method is to provide meaningful descriptive string in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct strings in this context.
The method shall return empty string, when it does not handle customization by itself.
in
AbstractInheritanceConstraint at line 137
final protected string
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other)
Returns the description of the failure when this constraint appears in context of an $operator expression.
The purpose of this method is to provide meaningful failure description in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct messages in this context.
The method shall return empty string, when it does not handle customization by itself.
at line 28
static UsesTrait
create(string $expected)
No description