Viewing file:  ExpectationDirector.php (5.54 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Mockery (https://docs.mockery.io/)
*
* @copyright https://github.com/mockery/mockery/blob/HEAD/COPYRIGHT.md
* @license https://github.com/mockery/mockery/blob/HEAD/LICENSE BSD 3-Clause License
* @link https://github.com/mockery/mockery for the canonical source repository
*/
namespace Mockery;
use Mockery;
use Mockery\Exception\NoMatchingExpectationException;
use function array_pop;
use function array_unshift;
use function end;
use const PHP_EOL;
class ExpectationDirector
{
/**
* Stores an array of all default expectations for this mock
*
* @var list<ExpectationInterface>
*/
protected $_defaults = [];
/**
* Stores an array of all expectations for this mock
*
* @var list<ExpectationInterface>
*/
protected $_expectations = [];
/**
* The expected order of next call
*
* @var int
*/
protected $_expectedOrder = null;
/**
* Mock object the director is attached to
*
* @var LegacyMockInterface|MockInterface
*/
protected $_mock = null;
/**
* Method name the director is directing
*
* @var string
*/
protected $_name = null;
/**
* Constructor
*
* @param string $name
*/
public function __construct($name, LegacyMockInterface $mock)
{
$this->_name = $name;
$this->_mock = $mock;
}
/**
* Add a new expectation to the director
*/
public function addExpectation(Expectation $expectation)
{
$this->_expectations[] = $expectation;
}
/**
* Handle a method call being directed by this instance
*
* @return mixed
*/
public function call(array $args)
{
$expectation = $this->findExpectation($args);
if ($expectation !== null) {
return $expectation->verifyCall($args);
}
$exception = new NoMatchingExpectationException(
'No matching handler found for '
. $this->_mock->mockery_getName() . '::'
. Mockery::formatArgs($this->_name, $args)
. '. Either the method was unexpected or its arguments matched'
. ' no expected argument list for this method'
. PHP_EOL . PHP_EOL
. Mockery::formatObjects($args)
);
$exception->setMock($this->_mock)
->setMethodName($this->_name)
->setActualArguments($args);
throw $exception;
}
/**
* Attempt to locate an expectation matching the provided args
*
* @return mixed
*/
public function findExpectation(array $args)
{
$expectation = null;
if ($this->_expectations !== []) {
$expectation = $this->_findExpectationIn($this->_expectations, $args);
}
if ($expectation === null && $this->_defaults !== []) {
return $this->_findExpectationIn($this->_defaults, $args);
}
return $expectation;
}
/**
* Return all expectations assigned to this director
*
* @return array<ExpectationInterface>
*/
public function getDefaultExpectations()
{
return $this->_defaults;
}
/**
* Return the number of expectations assigned to this director.
*
* @return int
*/
public function getExpectationCount()
{
$count = 0;
$expectations = $this->getExpectations();
if ($expectations === []) {
$expectations = $this->getDefaultExpectations();
}
foreach ($expectations as $expectation) {
if ($expectation->isCallCountConstrained()) {
++$count;
}
}
return $count;
}
/**
* Return all expectations assigned to this director
*
* @return array<ExpectationInterface>
*/
public function getExpectations()
{
return $this->_expectations;
}
/**
* Make the given expectation a default for all others assuming it was correctly created last
*
* @throws Exception
*
* @return void
*/
public function makeExpectationDefault(Expectation $expectation)
{
if (end($this->_expectations) === $expectation) {
array_pop($this->_expectations);
array_unshift($this->_defaults, $expectation);
return;
}
throw new Exception('Cannot turn a previously defined expectation into a default');
}
/**
* Verify all expectations of the director
*
* @throws Exception
*
* @return void
*/
public function verify()
{
if ($this->_expectations !== []) {
foreach ($this->_expectations as $expectation) {
$expectation->verify();
}
return;
}
foreach ($this->_defaults as $expectation) {
$expectation->verify();
}
}
/**
* Search current array of expectations for a match
*
* @param array<ExpectationInterface> $expectations
*
* @return null|ExpectationInterface
*/
protected function _findExpectationIn(array $expectations, array $args)
{
foreach ($expectations as $expectation) {
if (! $expectation->isEligible()) {
continue;
}
if (! $expectation->matchArgs($args)) {
continue;
}
return $expectation;
}
foreach ($expectations as $expectation) {
if ($expectation->matchArgs($args)) {
return $expectation;
}
}
return null;
}
}
|