Cerbero\LaravelEnum\Services\Inspector

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	hasSameNamespace()	0	3	1
A	useStatements()	0	3	1
A	caseAnnotation()	0	10	3
A	methodAnnotations()	0	4	1

<?php

declare(strict_types=1);

namespace Cerbero\LaravelEnum\Services;

use Cerbero\Enum\Services\Inspector as BaseInspector;
use Cerbero\LaravelEnum\Capsules;
use Cerbero\LaravelEnum\Concerns;
use Cerbero\LaravelEnum\Data\MethodAnnotation;
use UnitEnum;

/**
 * The enum inspector.
 *
 * @template TEnum of UnitEnum
 *
 * @extends BaseInspector<TEnum>
 */
final class Inspector extends BaseInspector
{
    /**
     * The main trait to supercharge enums.
     *
     * @var 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.

     */
    protected string $mainTrait = Concerns\Enumerates::class;

    /**
     * The capsules keyed by the related trait.
     *
     * @var array<class-string, class-string>

The doc comment array<class-string, class-string> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string, class-string>.

     */
    private array $capsules = [
        Concerns\EnumeratesCacheKeys::class => Capsules\CacheKey::class,
        Concerns\EnumeratesSessionKeys::class => Capsules\SessionKey::class,
    ];

    /**
     * Determine whether the given namespace matches the enum namespace.
     */
    public function hasSameNamespace(string $namespace): bool
    {
        return $this->reflection->getNamespaceName() . '\\' . class_basename($namespace) == $namespace;
    }

    /**
     * Retrieve the method annotation for the given case.
     */
    public function caseAnnotation(UnitEnum $case): MethodAnnotation
    {
        foreach ($this->capsules as $trait => $capsule) {
            if ($this->uses($trait)) {
                /** @var \BackedEnum $case */
                return MethodAnnotation::forCapsule($case, $capsule);
            }
        }

        return MethodAnnotation::forCase($case);
    }

    /**
     * Retrieve the use statements.
     *
     * @return array<string, class-string>

The doc comment array<string, class-string> at position 4 could not be parsed: Unknown type name 'class-string' at position 4 in array<string, class-string>.

     */
    public function useStatements(bool $includeExisting = true): array
    {
        return $this->useStatements ??= [...new UseStatements($this, $includeExisting)];
    }

    /**
     * Retrieve the method annotations.
     *
     * @return array<string, MethodAnnotation>
     */
    public function methodAnnotations(bool $includeExisting = true): array
    {
        /** @var array<string, MethodAnnotation> */
        return $this->methodAnnotations ??= [...new MethodAnnotations($this, $includeExisting)];
    }
}