FRZB\Component\TransactionalMessenger\Helper\ClassHelper

Complexity

Total Complexity

8

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	getShortName()	0	3	1
A	getParentReflectionClass()	0	3	2
A	getReflectionAttributes()	0	3	1
A	getReflectionClass()	0	6	3

<?php

declare(strict_types=1);

namespace FRZB\Component\TransactionalMessenger\Helper;

use JetBrains\PhpStorm\Immutable;

/** @internal */
#[Immutable]
final class ClassHelper
{
    final public const DEFAULT_SHORT_NAME = 'InvalidClassName';

    private function __construct()
    {
    }

    public static function getShortName(string|object $target): string
    {
        return self::getReflectionClass($target)?->getShortName() ?? self::DEFAULT_SHORT_NAME;
    }

    /**
     * @template T
     *
     * @param class-string<T>|T $target

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

     *
     * @return null|\ReflectionClass<T>
     */
    public static function getReflectionClass(string|object $target): ?\ReflectionClass
    {
        try {
            return $target instanceof \ReflectionClass ? $target : new \ReflectionClass($target);
        } catch (\ReflectionException) {
            return null;
        }
    }

    /**
     * @template T
     *
     * @param class-string<T>|T $target

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

     *
     * @return null|\ReflectionClass<T>
     */
    public static function getParentReflectionClass(string|object $target): ?\ReflectionClass
    {
        return self::getReflectionClass($target)?->getParentClass() ?: null;
    }

    /**
     * @template T
     *
     * @param class-string<T> $attributeClass

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

     *
     * @return \Iterator<\ReflectionAttribute<T>>
     */
    public static function getReflectionAttributes(string|object $target, string $attributeClass): iterable
    {
        return self::getReflectionClass($target)?->getAttributes($attributeClass, \ReflectionAttribute::IS_INSTANCEOF) ?? [];

The expression return self::getReflectionClass($target)->getAttributes($attributeClass, ReflectionAttribute::IS_INSTANCEOF) ?? array() returns the type ReflectionAttribute[]|array which is incompatible with the documented return type Iterator.

    }
}