Chris@14: <?php
Chris@14: /*
Chris@14:  * This file is part of the phpunit-mock-objects package.
Chris@14:  *
Chris@14:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@14:  *
Chris@14:  * For the full copyright and license information, please view the LICENSE
Chris@14:  * file that was distributed with this source code.
Chris@14:  */
Chris@14: namespace PHPUnit\Framework\MockObject;
Chris@14: 
Chris@14: use Exception;
Chris@14: use PHPUnit\Framework\MockObject\Builder\InvocationMocker as BuilderInvocationMocker;
Chris@14: use PHPUnit\Framework\MockObject\Builder\Match;
Chris@14: use PHPUnit\Framework\MockObject\Builder\NamespaceMatch;
Chris@14: use PHPUnit\Framework\MockObject\Matcher\Invocation as MatcherInvocation;
Chris@14: use PHPUnit\Framework\MockObject\Stub\MatcherCollection;
Chris@14: 
Chris@14: /**
Chris@14:  * Mocker for invocations which are sent from
Chris@14:  * MockObject objects.
Chris@14:  *
Chris@14:  * Keeps track of all expectations and stubs as well as registering
Chris@14:  * identifications for builders.
Chris@14:  */
Chris@14: class InvocationMocker implements MatcherCollection, Invokable, NamespaceMatch
Chris@14: {
Chris@14:     /**
Chris@14:      * @var MatcherInvocation[]
Chris@14:      */
Chris@14:     private $matchers = [];
Chris@14: 
Chris@14:     /**
Chris@14:      * @var Match[]
Chris@14:      */
Chris@14:     private $builderMap = [];
Chris@14: 
Chris@14:     /**
Chris@14:      * @var string[]
Chris@14:      */
Chris@14:     private $configurableMethods = [];
Chris@14: 
Chris@14:     /**
Chris@14:      * @param array $configurableMethods
Chris@14:      */
Chris@14:     public function __construct(array $configurableMethods)
Chris@14:     {
Chris@14:         $this->configurableMethods = $configurableMethods;
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param MatcherInvocation $matcher
Chris@14:      */
Chris@14:     public function addMatcher(MatcherInvocation $matcher)
Chris@14:     {
Chris@14:         $this->matchers[] = $matcher;
Chris@14:     }
Chris@14: 
Chris@14:     public function hasMatchers()
Chris@14:     {
Chris@14:         foreach ($this->matchers as $matcher) {
Chris@14:             if ($matcher->hasMatchers()) {
Chris@14:                 return true;
Chris@14:             }
Chris@14:         }
Chris@14: 
Chris@14:         return false;
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param mixed $id
Chris@14:      *
Chris@14:      * @return bool|null
Chris@14:      */
Chris@14:     public function lookupId($id)
Chris@14:     {
Chris@14:         if (isset($this->builderMap[$id])) {
Chris@14:             return $this->builderMap[$id];
Chris@14:         }
Chris@14: 
Chris@14:         return;
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param mixed $id
Chris@14:      * @param Match $builder
Chris@14:      *
Chris@14:      * @throws RuntimeException
Chris@14:      */
Chris@14:     public function registerId($id, Match $builder)
Chris@14:     {
Chris@14:         if (isset($this->builderMap[$id])) {
Chris@14:             throw new RuntimeException(
Chris@14:                 'Match builder with id <' . $id . '> is already registered.'
Chris@14:             );
Chris@14:         }
Chris@14: 
Chris@14:         $this->builderMap[$id] = $builder;
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param MatcherInvocation $matcher
Chris@14:      *
Chris@14:      * @return BuilderInvocationMocker
Chris@14:      */
Chris@14:     public function expects(MatcherInvocation $matcher)
Chris@14:     {
Chris@14:         return new BuilderInvocationMocker(
Chris@14:             $this,
Chris@14:             $matcher,
Chris@14:             $this->configurableMethods
Chris@14:         );
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param Invocation $invocation
Chris@14:      *
Chris@14:      * @return mixed
Chris@14:      *
Chris@14:      * @throws Exception
Chris@14:      */
Chris@14:     public function invoke(Invocation $invocation)
Chris@14:     {
Chris@14:         $exception      = null;
Chris@14:         $hasReturnValue = false;
Chris@14:         $returnValue    = null;
Chris@14: 
Chris@14:         foreach ($this->matchers as $match) {
Chris@14:             try {
Chris@14:                 if ($match->matches($invocation)) {
Chris@14:                     $value = $match->invoked($invocation);
Chris@14: 
Chris@14:                     if (!$hasReturnValue) {
Chris@14:                         $returnValue    = $value;
Chris@14:                         $hasReturnValue = true;
Chris@14:                     }
Chris@14:                 }
Chris@14:             } catch (Exception $e) {
Chris@14:                 $exception = $e;
Chris@14:             }
Chris@14:         }
Chris@14: 
Chris@14:         if ($exception !== null) {
Chris@14:             throw $exception;
Chris@14:         }
Chris@14: 
Chris@14:         if ($hasReturnValue) {
Chris@14:             return $returnValue;
Chris@14:         }
Chris@14: 
Chris@14:         if (\strtolower($invocation->getMethodName()) === '__tostring') {
Chris@14:             return '';
Chris@14:         }
Chris@14: 
Chris@14:         return $invocation->generateReturnValue();
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @param Invocation $invocation
Chris@14:      *
Chris@14:      * @return bool
Chris@14:      */
Chris@14:     public function matches(Invocation $invocation)
Chris@14:     {
Chris@14:         foreach ($this->matchers as $matcher) {
Chris@14:             if (!$matcher->matches($invocation)) {
Chris@14:                 return false;
Chris@14:             }
Chris@14:         }
Chris@14: 
Chris@14:         return true;
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * @return bool
Chris@14:      *
Chris@14:      * @throws \PHPUnit\Framework\ExpectationFailedException
Chris@14:      */
Chris@14:     public function verify()
Chris@14:     {
Chris@14:         foreach ($this->matchers as $matcher) {
Chris@14:             $matcher->verify();
Chris@14:         }
Chris@14:     }
Chris@14: }