edde-framework/edde-framework

<?php
    declare(strict_types=1);

    namespace Edde\Api\Http\Client;

    use Edde\Api\Http\IRequest;
    use Edde\Api\Url\IUrl;

    interface IHttpClient {
        /**
         * do an arbitrary request; the all others are shortcut to this method
         *
         * @param IRequest $request
         *
         * @return IHttpHandler
         */
        public function request(IRequest $request): IHttpHandler;

        /**
         * @param string|IUrl $url
         *
         * @return IHttpHandler
         */
        public function get($url): IHttpHandler;

        /**
         * @param string|IUrl $url target url address
         *
         * @return IHttpHandler
         */
        public function post($url): IHttpHandler;

        /**
         * @param string|IUrl $url
         *
         * @return IHttpHandler
         */
        public function put($url): IHttpHandler;

        /**
         * @param string|IUrl $url
         *
         * @return IHttpHandler
         */
        public function patch($url): IHttpHandler;

        /**
         * @param string|IUrl $url
         *
         * @return IHttpHandler
         */
        public function delete($url): IHttpHandler;

        /**
         * @param $url
         *
         * @return IHttpHandler
         */
        public function head($url): IHttpHandler;

        /**
         * main purpose of this method is to "touch" the given url without an anwser
         *
         * @param string|IUrl $url
         * @param string      $method
         * @param array       $headerList
         *
         * @return IHttpClient
         */
        public function touch($url, string $method = 'HEAD', array $headerList = []): IHttpClient;
    }