Documentation

PHPUnit_Framework_MockObject_Matcher_Parameters extends PHPUnit_Framework_MockObject_Matcher_StatelessInvocation
in package

Invocation matcher which looks for specific parameters in the invocations.

Checks the parameters of all incoming invocations, the parameter list is checked against the defined constraints in $parameters. If the constraint is met it will return true in matches().

Tags
since

Class available since Release 1.0.0

Table of Contents

$invocation  : PHPUnit_Framework_MockObject_Invocation
$parameters  : array<string|int, PHPUnit_Framework_Constraint>
__construct()  : mixed
invoked()  : mixed
Registers the invocation $invocation in the object as being invoked.
matches()  : bool
toString()  : string
verify()  : 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.

Properties

Methods

__construct()

public __construct(array<string|int, mixed> $parameters) : mixed
Parameters
$parameters : array<string|int, mixed>
Return values
mixed

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

toString()

public toString() : string
Return values
string

verify()

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 verify() : bool
Tags
throws
PHPUnit_Framework_ExpectationFailedException
Return values
bool

Search results