PHPUnit_Framework_MockObject_Matcher_Invocation
extends
PHPUnit_Framework_SelfDescribing, PHPUnit_Framework_MockObject_Verifiable
in
Interface for classes which matches an invocation based on its method name, argument, order or call count.
Tags
Table of Contents
- invoked() : mixed
- Registers the invocation $invocation in the object as being invoked.
- matches() : bool
- 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.
- toString() : string
- Returns a string representation of the object.
- verify() : mixed
- Verifies that the current expectation is valid. If everything is OK the code should just return, if not it must throw an exception.
Methods
invoked()
Registers the invocation $invocation in the object as being invoked.
public
invoked(PHPUnit_Framework_MockObject_Invocation $invocation) : mixed
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
- $invocation : PHPUnit_Framework_MockObject_Invocation
-
Object containing information on a mocked or stubbed method which was invoked.
Return values
mixed —matches()
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.
public
matches(PHPUnit_Framework_MockObject_Invocation $invocation) : bool
Parameters
- $invocation : PHPUnit_Framework_MockObject_Invocation
-
Object containing information on a mocked or stubbed method which was invoked.
Return values
bool —toString()
Returns a string representation of the object.
public
toString() : string
Return values
string —verify()
Verifies that the current expectation is valid. If everything is OK the code should just return, if not it must throw an exception.
public
verify() : mixed