bearsunday / BEAR.Resource

src/ResourceInterface.php

<?php

declare(strict_types=1);

namespace BEAR\Resource;

/** @psalm-import-type Query from Types */
interface ResourceInterface
{
    /**
     * Return new resource object instance
     *
     * @param AbstractUri|string $uri
     */
    public function newInstance($uri): ResourceObject;

    /**
     * Set resource object
     */
    public function object(ResourceObject $ro): RequestInterface;

    /**
     * Set URI
     *
     * @param AbstractUri|string $uri
     *
     * @deprecated Use createRequest() instead
     */
    public function uri($uri): RequestInterface;

    /**
     * Create a request atomically (coroutine-safe)
     *
     * @param Query $query

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

     */
    public function createRequest(string $method, string $uri, array $query = []): RequestInterface;

    /**
     * Execute a GET request with link crawl
     *
     * @param Query $query
     */
    public function crawl(string $uri, string $linkKey, array $query = []): ResourceObject;

    /**
     * Hyper reference (Hypertext As The Engine Of Application State)
     *
     * @param Query $query
     */
    public function href(string $rel, array $query = [], ResourceObject|null $ro = null): ResourceObject;

    /**
     * Invoke GET request
     *
     * @param Query $query
     */
    public function get(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke POST request
     *
     * @param Query $query
     */
    public function post(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke PUT request
     *
     * @param Query $query
     */
    public function put(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke PATCH request
     *
     * @param Query $query
     */
    public function patch(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke DELETE request
     *
     * @param Query $query
     */
    public function delete(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke HEAD request
     *
     * @param Query $query
     */
    public function head(string $uri, array $query = []): ResourceObject;

    /**
     * Invoke OPTIONS request
     *
     * @param Query $query
     */
    public function options(string $uri, array $query = []): ResourceObject;
}