ObjectPropertiesEqualTo
final class ObjectPropertiesEqualTo extends AbstractConstraint
Constraint that accepts objects having properties equal to specified ones.
Compares only properties present in the array of expectations. A property is
defined as either an attribute value or a value returned by object's method
callable without arguments. The == operator (equality) is used for
comparison.
Any key in $expected array ending with "()" is considered to be a
method that returns property value.
// ...
$matcher = ObjectPropertiesEqualTo::create([
'getName()' => 'John', 'age' => '21'
]);
self::assertThat(new class {
public static $age = 21;
public static getName(): string {
return 'John';
}
}, $matcher);Traits
Methods
Returns a string representation of the constraint.
Returns the description of the failure.
Returns the description of the failure when this constraint appears in context of an $operator expression.
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
No description
Returns an instance of SelectionInterface which defines expected values.
Returns an instance of ComparatorInterface which implements comparison operator.
Evaluates the constraint for parameter $other.
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
No description
No description
Creates instance of ObjectPropertySelector.
Creates instance of EqualityComparator.
Details
in
ShortFailureDescriptionTrait at line 26
abstract string
toString()
Returns a string representation of the constraint.
in
ShortFailureDescriptionTrait at line 36
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.
in
ShortFailureDescriptionTrait at line 57
final 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 failue 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.
in
ShortFailureDescriptionTrait at line 83
abstract 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
ShortFailureDescriptionTrait at line 85
abstract protected Exporter
exporter()
No description
in
AbstractConstraint at line 55
final protected
__construct(ComparatorInterface $comparator, SelectionInterface $expected, RecursiveUnwrapperInterface $unwrapper)
No description
in
AbstractConstraint at line 68
final SelectionInterface
getSelection()
Returns an instance of SelectionInterface which defines expected values.
in
AbstractConstraint at line 76
final ComparatorInterface
getComparator()
Returns an instance of ComparatorInterface which implements comparison operator.
in
AbstractConstraint at line 112
final bool|null
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.
in
AbstractConstraint at line 174
final protected bool
matches(mixed $other)
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
in
ConstraintImplementationTrait at line 25
static ConstraintImplementationTrait
create(array $expected)
No description
in
ValidateExpectationsTrait at line 25
static protected void
validateExpectations(array $expected, int $argument, int $distance = 1)
No description
at line 61
static protected ValueSelectorInterface
makeSelector()
Creates instance of ObjectPropertySelector.
at line 53
static protected ComparatorInterface
makeComparator()
Creates instance of EqualityComparator.