bearsunday / BEAR.Resource

src/Request.php

<?php

declare(strict_types=1);

namespace BEAR\Resource;

use OutOfRangeException;
use Override;

use function array_merge;
use function in_array;

/**
 * @property $this $lazy
 * @property $this $eager
 * @psalm-suppress PropertyNotSetInConstructor for DSL
 * @psalm-import-type Query from Types
 */
final class Request extends AbstractRequest
{
    public const GET = 'get';
    public const POST = 'post';
    public const PUT = 'put';
    public const PATCH = 'patch';
    public const DELETE = 'delete';
    public const HEAD = 'head';
    public const OPTIONS = 'options';

    /** @psalm-suppress ImplementedReturnTypeMismatch */

    /** @psalm-suppress PossiblyUnusedReturnValue */
    #[Override]
    public function __get(string $name): mixed
    {
        if ($name === 'eager' || $name === 'lazy') {
            $this->in = $name;

            return $this;
        }

        if (in_array($name, ['code', 'headers', 'body'], true)) {
            return parent::__get($name);
        }

        throw new OutOfRangeException($name);
    }

    /**
     * {@inheritDoc}
     *
     * @param Query $query

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

     */
    #[Override]
    public function withQuery(array $query): RequestInterface
    {
        $this->query = $query;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function addQuery(array $query): RequestInterface
    {
        $this->query = array_merge($this->query, $query);

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function toUriWithMethod(): string
    {
        $uri = $this->toUri();

        return "{$this->method} {$uri}";
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function toUri(): string
    {
        $this->resourceObject->uri->query = $this->query;

        return (string) $this->resourceObject->uri;
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function linkSelf(string $linkKey): RequestInterface
    {
        $this->links[] = new LinkType($linkKey, LinkType::SELF_LINK);

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function linkNew(string $linkKey): RequestInterface
    {
        $this->links[] = new LinkType($linkKey, LinkType::NEW_LINK);

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    #[Override]
    public function linkCrawl(string $linkKey): RequestInterface
    {
        $this->links[] = new LinkType($linkKey, LinkType::CRAWL_LINK);

        return $this;
    }
}