bearsunday / BEAR.Resource

src/Anchor.php

<?php

declare(strict_types=1);

namespace BEAR\Resource;

use BEAR\Resource\Annotation\Link as LinkAnnotation;
use BEAR\Resource\Exception\LinkException;
use Override;
use Ray\Aop\ReflectionMethod;

use function array_merge;
use function assert;
use function is_array;
use function ucfirst;
use function uri_template;

/**
 * @psalm-import-type MethodUri from Types
 * @psalm-import-type Query from Types
 */
final class Anchor implements AnchorInterface
{
    /**
     * {@inheritDoc}
     *
     * @throws LinkException
     */
    #[Override]
    public function href(string $rel, AbstractRequest $request, array $query): array
    {
        $classMethod = 'on' . ucfirst($request->method);
        $annotations = (new ReflectionMethod($request->resourceObject::class, $classMethod))->getAnnotations();
        foreach ($annotations as $annotation) {
            if ($this->isValidLinkAnnotation($annotation, $rel)) {
                assert($annotation instanceof LinkAnnotation);

                return $this->getMethodUri($request, $query, $annotation);

The expression return $this->getMethodUri($request, $query, $annotation) returns the type array<integer,string> which is incompatible with the return type mandated by BEAR\Resource\AnchorInterface::href() of BEAR\Resource\MethodUri.

            }
        }

        throw new LinkException("rel:{$rel} class:" . $request->resourceObject::class, 500);
    }

    private function isValidLinkAnnotation(object $annotation, string $rel): bool
    {
        /** @psalm-suppress RedundantConditionGivenDocblockType */
        return $annotation instanceof LinkAnnotation && $annotation->rel !== null && $annotation->rel === $rel;
    }

    /**
     * @param Query $query

The type BEAR\Resource\Query was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return MethodUri

The type BEAR\Resource\MethodUri was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    private function getMethodUri(AbstractRequest $request, array $query, LinkAnnotation $annotation): array
    {
        /** @var array|mixed $body */
        $body = $request->resourceObject->body;
        $query = is_array($body) ? array_merge($body, $query) : [];
        $uri = uri_template($annotation->href, $query);

        return [$annotation->method, $uri];

The expression return array($annotation->method, $uri) returns the type array<integer,string> which is incompatible with the documented return type BEAR\Resource\MethodUri.

    }
}