Request.php

<?php

declare(strict_types=1);

namespace Saloon\Http;

use LogicException;
use Saloon\Enums\Method;
use Saloon\Traits\Bootable;
use Saloon\Traits\Makeable;
use Saloon\Traits\Macroable;
use Saloon\Traits\HasDebugging;
use Saloon\Traits\Conditionable;
use Saloon\Traits\HasMockClient;
use Saloon\Traits\HandlesPsrRequest;
use Saloon\Traits\ManagesExceptions;
use Saloon\Traits\Auth\AuthenticatesRequests;
use Saloon\Traits\RequestProperties\HasTries;
use Saloon\Traits\Responses\HasCustomResponses;
use Saloon\Traits\Request\CreatesDtoFromResponse;
use Saloon\Traits\RequestProperties\HasRequestProperties;

abstract class Request
{
    use CreatesDtoFromResponse;
    use AuthenticatesRequests;
    use HasRequestProperties;
    use HasCustomResponses;
    use ManagesExceptions;
    use HandlesPsrRequest;
    use HasMockClient;
    use Conditionable;
    use HasDebugging;
    use Macroable;
    use HasTries;
    use Bootable;
    use Makeable;

    /**
     * When non-null, overrides connector / OAuth resolution for absolute endpoints in resolveEndpoint().
     * null = inherit. Set true/false on the instance or declare on your request subclass.
     */
    public ?bool $allowBaseUrlOverride = null;

    /**
     * Define the HTTP method.
     */
    protected Method $method;

    /**
     * Get the method of the request.
     */
    public function getMethod(): Method
    {
        if (! isset($this->method)) {
            throw new LogicException('Your request is missing a HTTP method. You must add a method property like [protected Method $method = Method::GET]');
        }

        return $this->method;
    }

    /**
     * Ensure cloned requests do not share mutable object state (query, headers, etc.).
     *
     * Without this, a shallow clone reuses the same {@see \Saloon\Repositories\ArrayStore}
     * instances when they were initialized before cloning, which breaks concurrent pools
     * (e.g. paginated requests mutating the same query bag).
     */
    public function __clone(): void
    {
        if (isset($this->query)) {
            $this->query = clone $this->query;
        }

        if (isset($this->headers)) {
            $this->headers = clone $this->headers;
        }

        if (isset($this->config)) {
            $this->config = clone $this->config;
        }

        if (isset($this->delay)) {
            $this->delay = clone $this->delay;
        }

        if (isset($this->middlewarePipeline)) {
            $this->middlewarePipeline = clone $this->middlewarePipeline;
        }
    }

    /**
     * Define the endpoint for the request.
     */
    abstract public function resolveEndpoint(): string;
}