~NAXC~

File Content: `Invocation.php`

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Framework\MockObject;

use function array_map;
use function explode;
use function get_class;
use function implode;
use function is_object;
use function sprintf;
use function strpos;
use function strtolower;
use function substr;
use Doctrine\Instantiator\Instantiator;
use PHPUnit\Framework\SelfDescribing;
use PHPUnit\Util\Type;
use SebastianBergmann\Exporter\Exporter;
use stdClass;
use Throwable;

/**
 * @internal This class is not covered by the backward compatibility promise for PHPUnit
 */
final class Invocation implements SelfDescribing
{
    /**
     * @var string
     */
    private $className;

    /**
     * @var string
     */
    private $methodName;

    /**
     * @var array
     */
    private $parameters;

    /**
     * @var string
     */
    private $returnType;

    /**
     * @var bool
     */
    private $isReturnTypeNullable = false;

    /**
     * @var bool
     */
    private $proxiedCall;

    /**
     * @var object
     */
    private $object;

    public function __construct(string $className, string $methodName, array $parameters, string $returnType, object $object, bool $cloneObjects = false, bool $proxiedCall = false)
    {
        $this->className   = $className;
        $this->methodName  = $methodName;
        $this->parameters  = $parameters;
        $this->object      = $object;
        $this->proxiedCall = $proxiedCall;

        if (strtolower($methodName) === '__tostring') {
            $returnType = 'string';
        }

        if (strpos($returnType, '?') === 0) {
            $returnType                 = substr($returnType, 1);
            $this->isReturnTypeNullable = true;
        }

        $this->returnType = $returnType;

        if (!$cloneObjects) {
            return;
        }

        foreach ($this->parameters as $key => $value) {
            if (is_object($value)) {
                $this->parameters[$key] = $this->cloneObject($value);
            }
        }
    }

    public function getClassName(): string
    {
        return $this->className;
    }

    public function getMethodName(): string
    {
        return $this->methodName;
    }

    public function getParameters(): array
    {
        return $this->parameters;
    }

    /**
     * @throws RuntimeException
     *
     * @return mixed Mocked return value
     */
    public function generateReturnValue()
    {
        if ($this->isReturnTypeNullable || $this->proxiedCall) {
            return null;
        }

        $union = false;

        if (strpos($this->returnType, '|') !== false) {
            $types = explode('|', $this->returnType);
            $union = true;
        } else {
            $types = [$this->returnType];
        }

        $types = array_map('strtolower', $types);

        if (in_array('', $types, true) ||
            in_array('null', $types, true) ||
            in_array('mixed', $types, true) ||
            in_array('void', $types, true)) {
            return null;
        }

        if (in_array('false', $types, true) ||
            in_array('bool', $types, true)) {
            return false;
        }

        if (in_array('float', $types, true)) {
            return 0.0;
        }

        if (in_array('int', $types, true)) {
            return 0;
        }

        if (in_array('string', $types, true)) {
            return '';
        }

        if (in_array('array', $types, true)) {
            return [];
        }

        if (in_array('static', $types, true)) {
            try {
                return (new Instantiator)->instantiate(get_class($this->object));
            } catch (Throwable $t) {
                throw new RuntimeException(
                    $t->getMessage(),
                    (int) $t->getCode(),
                    $t
                );
            }
        }

        if (in_array('object', $types, true)) {
            return new stdClass;
        }

        if (in_array('callable', $types, true) ||
            in_array('closure', $types, true)) {
            return static function (): void
            {
            };
        }

        if (in_array('traversable', $types, true) ||
            in_array('generator', $types, true) ||
            in_array('iterable', $types, true)) {
            $generator = static function (): \Generator
            {
                yield from [];
            };

            return $generator();
        }

        if (!$union) {
            try {
                return (new Generator)->getMock($this->returnType, [], [], '', false);
            } catch (Throwable $t) {
                throw new RuntimeException(
                    sprintf(
                        'Return value for %s::%s() cannot be generated: %s',
                        $this->className,
                        $this->methodName,
                        $t->getMessage(),
                    ),
                    (int) $t->getCode(),
                );
            }
        }

        throw new RuntimeException(
            sprintf(
                'Return value for %s::%s() cannot be generated because the declared return type is a union, please configure a return value for this method',
                $this->className,
                $this->methodName
            )
        );
    }

    public function toString(): string
    {
        $exporter = new Exporter;

        return sprintf(
            '%s::%s(%s)%s',
            $this->className,
            $this->methodName,
            implode(
                ', ',
                array_map(
                    [$exporter, 'shortenedExport'],
                    $this->parameters
                )
            ),
            $this->returnType ? sprintf(': %s', $this->returnType) : ''
        );
    }

    public function getObject(): object
    {
        return $this->object;
    }

    private function cloneObject(object $original): object
    {
        if (Type::isCloneable($original)) {
            return clone $original;
        }

        return $original;
    }
}
File Content: Invocation.php

File Content: `Invocation.php`
