1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?php
namespace phpmock\spy;
use InvalidArgumentException;
use phpmock\Mock;
/**
* A spy records the arguments and results of function calls.
*
* If you create a Spy without a mock function, it will use the existing
* function.
*
* Example:
* <code>
* namespace foo;
*
* use phpmock\spy\Spy;
*
* function bar($min, $max) {
* return rand($min, $max) + 3;
* }
*
* $spy = new Spy(__NAMESPACE__, "rand");
* $spy->enable();
*
* $result = bar(1, 2);
*
* assert ([1, 2] == $spy->getInvocations()[0]->getArguments());
* assert ($result == $spy->getInvocations()[0]->getReturn() + 3);
* </code>
*
* @author Markus Malkusch <markus@malkusch.de>
* @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
* @license http://www.wtfpl.net/txt/copying/ WTFPL
*/
class Spy extends Mock
{
/**
* @var Invocation[] The recorded calls.
*/
private $invocations = [];
/**
* Initializes the spy.
*
* If no function is specified it will use the existing function.
*
* @param string $namespace The namespace for the mock function.
* @param string $name The function name of the mocked function.
* @param callable|null $function The mock function, or null for using the existing function.
*
* @throws InvalidArgumentException If the provided function is not callable.
*/
public function __construct($namespace, $name, $function = null)
{
if ($function !== null && !is_callable($function)) {
throw new InvalidArgumentException('The function must be callable.');
}
parent::__construct($namespace, $name, $function ?: $name);
}
public function call(array $arguments)
{
$return = null;
$exception = null;
try {
$return = parent::call($arguments);
return $return;
} catch (\Exception $e) {
$exception = $e;
throw $e;
} finally {
$this->invocations[] = new Invocation($arguments, $return, $exception);
}
}
/**
* Returns the recorded function calls and its arguments.
*
* @return Invocation[] The recorded function arguments.
*/
public function getInvocations()
{
return $this->invocations;
}
}
|
