interface PHPUnit_Framework_MockObject_Matcher_Invocation in Zircon Profile 8

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

@since Interface available since Release 1.0.0

Hierarchy

• interface \PHPUnit_Framework_SelfDescribing; interface \PHPUnit_Framework_MockObject_Verifiable
  • interface \PHPUnit_Framework_MockObject_Matcher_Invocation

File

vendor/phpunit/phpunit-mock-objects/src/Framework/MockObject/Matcher/Invocation.php, line 17

interface PHPUnit_Framework_MockObject_Matcher_Invocation extends PHPUnit_Framework_SelfDescribing, PHPUnit_Framework_MockObject_Verifiable {

  /**
   * 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.
   *
   * @param  PHPUnit_Framework_MockObject_Invocation $invocation
   *                                                             Object containing information on a mocked or stubbed method which
   *                                                             was invoked.
   * @return mixed
   */
  public function invoked(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.
   *
   * @param  PHPUnit_Framework_MockObject_Invocation $invocation
   *                                                             Object containing information on a mocked or stubbed method which
   *                                                             was invoked.
   * @return bool
   */
  public function matches(PHPUnit_Framework_MockObject_Invocation $invocation);

}

Members

Name	Modifiers	Type	Description	Overrides
PHPUnit_Framework_MockObject_Matcher_Invocation::invoked	public	function	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.	4
PHPUnit_Framework_MockObject_Matcher_Invocation::matches	public	function	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.	7
PHPUnit_Framework_MockObject_Verifiable::verify	public	function	Verifies that the current expectation is valid. If everything is OK the code should just return, if not it must throw an exception.	9
PHPUnit_Framework_SelfDescribing::toString	public	function	Returns a string representation of the object.	57