Spiral\Core\Config\DeprecationProxy

Complexity

Total Complexity

6

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Test Coverage

Coverage

30.76%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	4
A	getInterface()	0	12	2

<?php

declare(strict_types=1);

namespace Spiral\Core\Config;

/**
 * @internal
 */
final class DeprecationProxy extends Proxy
{
    /**
     * @param class-string $interface

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    public function __construct(
        string $interface,
        bool $singleton = false,
        private readonly string|\BackedEnum|null $scope = null,
        private readonly ?string $version = null,
        private readonly ?string $message = null,
    ) {
        if (($scope === null || $version === null) && $message === null) {
            throw new \InvalidArgumentException('Scope and version or custom message must be provided.');
        }

        parent::__construct($interface, $singleton);
    }

    /**
     * @return class-string

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     * @deprecated
     */
    public function getInterface(): string
    {
        $message = $this->message ?? \sprintf(
            'Using `%s` outside of the `%s` scope is deprecated and will be impossible in version %s.',
            $this->interface,
            $this->scope instanceof \BackedEnum ? $this->scope->value : $this->scope,

Accessing value on the interface BackedEnum suggest that you code against a concrete implementation. How about adding an instanceof check?

            $this->version,
        );

        @\trigger_error($message, \E_USER_DEPRECATED);

        return parent::getInterface();

The function Spiral\Core\Config\Proxy::getInterface() has been deprecated: Use {@see getReturnClass()} instead.

    }
}