bearsunday / BEAR.Resource

src/RequestInterface.php

<?php

declare(strict_types=1);

namespace BEAR\Resource;

/**
 * @property AbstractRequest $eager
 * @property AbstractRequest $lazy
 * @psalm-import-type Query from Types
 */
interface RequestInterface
{
    /**
     * InvokerInterface resource request
     *
     * @param Query $query

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

     */
    public function __invoke(array|null $query = null): ResourceObject;

    /**
     * Set query
     *
     * @param Query $query
     *
     * @psalm-suppress PossiblyUnusedReturnValue
     */
    public function withQuery(array $query): self;

    /**
     * Merge query
     *
     * @param Query $query
     *
     * @psalm-suppress PossiblyUnusedReturnValue
     */
    public function addQuery(array $query): self;

    /**
     * To Request URI string
     */
    public function toUri(): string;

    /**
     * To Request URI string with request method
     */
    public function toUriWithMethod(): string;

    /**
     * Return request hash
     */
    public function hash(): string;

    /** @return AbstractRequest|ResourceObject */
    public function request();

    /**
     * Replace linked resource
     */
    public function linkSelf(string $linkKey): self;

    /**
     * Add linked resource
     */
    public function linkNew(string $linkKey): self;

    /**
     * Crawl resource with link key
     */
    public function linkCrawl(string $linkKey): self;
}