MethodInvokedAtIndex.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\TestFramework\Unit\Matcher;

use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\MockObject\Invocation as BaseInvocation;

class MethodInvokedAtIndex implements \PHPUnit\Framework\MockObject\Matcher\Invocation
{
    private $sequenceIndex;

    private $currentIndex = -1;

    private $indexes = [];

    public function __construct($sequenceIndex)
    {
        $this->sequenceIndex = $sequenceIndex;
    }

    public function toString(): string
    {
        return 'invoked at sequence index ' . $this->sequenceIndex;
    }

    public function matches(BaseInvocation $invocation): bool
    {
        if (!isset($this->indexes[$invocation->getMethodName()])) {
            $this->indexes[$invocation->getMethodName()] = 0;
        } else {
            $this->indexes[$invocation->getMethodName()]++;
        }
        $this->currentIndex++;

        return $this->indexes[$invocation->getMethodName()] == $this->sequenceIndex;
    }

    public function invoked(BaseInvocation $invocation)
    {
    }

    public function verify(): void
    {
        if ($this->currentIndex < $this->sequenceIndex) {
            throw new ExpectationFailedException(
                \sprintf(
                    'The expected invocation at index %s was never reached.',
                    $this->sequenceIndex
                )
            );
        }
    }
}