interface PHPUnit_Framework_MockObject_Matcher_Invocation implements SelfDescribing, PHPUnit_Framework_MockObject_Verifiable (View source)

Interface for classes which matches an invocation based on its method name, argument, order or call count.

Methods

verify()

Verifies that the current expectation is valid. If everything is OK the code should just return, if not it must throw an exception.

mixed
invoked(PHPUnit_Framework_MockObject_Invocation $invocation)

Registers the invocation $invocation in the object as being invoked.

bool
matches(PHPUnit_Framework_MockObject_Invocation $invocation)

Checks if the invocation $invocation matches the current rules. If it does the matcher will get the invoked() method called which should check if an expectation is met.

Details

verify()

Verifies that the current expectation is valid. If everything is OK the code should just return, if not it must throw an exception.

Exceptions

ExpectationFailedException

mixed invoked(PHPUnit_Framework_MockObject_Invocation $invocation)

Registers the invocation $invocation in the object as being invoked.

This will only occur after matches() returns true which means the current invocation is the correct one.

The matcher can store information from the invocation which can later be checked in verify(), or it can check the values directly and throw and exception if an expectation is not met.

If the matcher is a stub it will also have a return value.

Parameters

PHPUnit_Framework_MockObject_Invocation $invocation Object containing information on a mocked or stubbed method which was invoked

Return Value

mixed

bool matches(PHPUnit_Framework_MockObject_Invocation $invocation)

Checks if the invocation $invocation matches the current rules. If it does the matcher will get the invoked() method called which should check if an expectation is met.

Parameters

PHPUnit_Framework_MockObject_Invocation $invocation Object containing information on a mocked or stubbed method which was invoked

Return Value

bool