Payever\ExternalIntegration\Core\Http\RequestBuilder

Complexity

Total Complexity

39

Size/Duplication

Total Lines	480
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

36 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	setUrl()	0	5	1
A	addRawHeader()	0	7	1
A	getDefaultHeaders()	0	4	1
A	getHeader()	0	7	2
A	containsParam()	0	3	1
A	post()	0	3	1
A	getResponseEntity()	0	3	1
A	getRequestEntity()	0	3	1
A	addParam()	0	5	1
A	contentTypeIsJson()	0	5	1
A	getParam()	0	7	2
A	getParams()	0	3	1
A	removeHeader()	0	5	1
A	patch()	0	3	1
A	setHeaders()	0	5	1
A	removeParam()	0	5	1
A	setFormUrlencoded()	0	5	1
A	get()	0	3	1
A	getMethod()	0	3	1
A	setResponseEntity()	0	5	1
A	getHeaders()	0	3	1
A	getUrl()	0	3	1
A	cleanHeaders()	0	5	1
A	build()	0	17	1
A	setProtocolVersion()	0	5	1
A	getProtocolVersion()	0	3	1
A	cleanParams()	0	5	1
A	setMethod()	0	7	2
A	setParams()	0	5	1
A	containsHeader()	0	3	1
A	delete()	0	3	1
A	addHeader()	0	5	1
A	put()	0	3	1
A	setRequestEntity()	0	5	1
A	getMethods()	0	3	1

<?php

/**
 * PHP version 5.4 and 8
 *
 * @category  Http
 * @package   Payever\Core
 * @author    payever GmbH <service@payever.de>
 * @copyright 2017-2021 payever GmbH
 * @license   MIT <https://opensource.org/licenses/MIT>
 * @link      https://docs.payever.org/shopsystems/api/getting-started
 */

namespace Payever\ExternalIntegration\Core\Http;

use Payever\ExternalIntegration\Core\Engine;

/**
 * This class represents Request Builder
 * @SuppressWarnings(PHPMD.StaticAccess)
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class RequestBuilder
{
    /** @var null|string $url */
    protected $url;

    /** @var string $method */
    protected $method = Request::METHOD_GET;

    /** @var array $headers */
    protected $headers = [];

    /** @var array $params */
    protected $params = [];

    /** @var string $protocolVersion */
    protected $protocolVersion = '1.1';

    /** @var RequestEntity $requestEntity */
    protected $requestEntity;

    /** @var ResponseEntity $responseEntity */
    protected $responseEntity;

    /**
     * @param string $url
     * @param string $method
     */
    public function __construct($url = null, $method = Request::METHOD_GET)
    {
        $this->method = $method;
        $this->url = $url;
        $this->requestEntity = new RequestEntity();
        $this->responseEntity = new ResponseEntity();
        $this->headers = $this->getDefaultHeaders();
    }

    /**
     * Instantiates RequestBuilder with GET method set
     *
     * @param string|null $url
     *
     * @return self
     */
    public static function get($url = null)
    {
        return new static($url, Request::METHOD_GET);
    }

    /**
     * Instantiates RequestBuilder with POST method set
     *
     * @param string|null $url
     *
     * @return self
     */
    public static function post($url = null)
    {
        return new static($url, Request::METHOD_POST);
    }

    /**
     * Instantiates RequestBuilder with PUT method set
     *
     * @param string|null $url
     * @return self
     */
    public static function put($url = null)
    {
        return new static($url, Request::METHOD_PUT);
    }

    /**
     * Instantiates RequestBuilder with PATCH method set
     *
     * @param string|null $url
     * @return self
     */
    public static function patch($url = null)
    {
        return new static($url, Request::METHOD_PATCH);
    }

    /**
     * Instantiates RequestBuilder with DELETE method set
     *
     * @param string|null $url
     * @return self
     */
    public static function delete($url = null)
    {
        return new static($url, Request::METHOD_DELETE);
    }

    /**
     * Builds Request object
     *
     * @return Request
     */
    public function build()
    {
        $request = new Request();

        $request
            ->setUrl($this->getUrl())
            ->setMethod($this->getMethod())
            ->setHeaders($this->getHeaders())
            ->setParams($this->getParams())
            ->setProtocolVersion($this->getProtocolVersion())
            ->setRequestEntity($this->getRequestEntity())
            ->setResponseEntity($this->getResponseEntity())
            ;

        $request->getRequestEntity()->load($request->getParams());

        return $request;
    }

    /**
     * Adds Header to Headers array
     *
     * @param string      $name
     * @param string|null $value
     *
     * @return self
     */
    public function addHeader($name, $value = null)
    {
        $this->headers[$name] = $value;

        return $this;
    }

    /**
     * Adds Header from a string
     *
     * @param string $string
     *
     * @return self
     */
    public function addRawHeader($string)
    {
        $pieces = explode(':', $string, 2);

        $this->addHeader($pieces[0], $pieces[1]);

        return $this;
    }

    /**
     * Replaces Headers with given array
     *
     * @param array $headers
     *
     * @return self
     */
    public function setHeaders($headers)
    {
        $this->headers = $headers;

        return $this;
    }

    /**
     * Returns Header value from Headers array with given name
     *
     * @param string $name
     *
     * @return bool|string
     */
    public function getHeader($name)
    {
        if ($this->containsHeader($name)) {
            return $this->headers[$name];
        }

        return false;
    }

    /**
     * Returns Headers array
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Cleans Headers array
     *
     * @return self
     */
    public function cleanHeaders()
    {
        $this->headers = [];

        return $this;
    }

    /**
     * Returns if the Header with given name is set
     *
     * @param string $name
     *
     * @return bool
     */
    public function containsHeader($name)
    {
        return isset($this->headers[$name]);
    }

    /**
     * Removes Header with given name from Headers array
     *
     * @param string $name
     *
     * @return self
     */
    public function removeHeader($name)
    {
        unset($this->headers[$name]);

        return $this;
    }

    /**
     * Adds Param to Params array
     *
     * @param string      $name
     * @param string|null $value
     *
     * @return self
     */
    public function addParam($name, $value = null)
    {
        $this->params[$name] = $value;

        return $this;
    }

    /**
     * Replaces Params with given array
     *
     * @param array $params
     *
     * @return self
     */
    public function setParams($params)
    {
        $this->params = $params;

        return $this;
    }

    /**
     * Returns Param value from Params array with given name
     *
     * @param string $name
     *
     * @return bool|string
     */
    public function getParam($name)
    {
        if ($this->containsParam($name)) {
            return $this->params[$name];
        }

        return false;
    }

    /**
     * Returns Params array
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Cleans Params array
     *
     * @return self
     */
    public function cleanParams()
    {
        $this->params = [];

        return $this;
    }

    /**
     * Returns if the Param with given name is set
     *
     * @param string $name
     *
     * @return bool
     */
    public function containsParam($name)
    {
        return isset($this->params[$name]);
    }

    /**
     * Removes Param with given name from Params array
     *
     * @param string $name
     *
     * @return self
     */
    public function removeParam($name)
    {
        unset($this->params[$name]);

        return $this;
    }

    /**
     * Sets URL
     *
     * @param string $url
     *
     * @return self
     */
    public function setUrl($url)
    {
        $this->url = $url;

        return $this;
    }

    /**
     * Returns URL
     *
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * Sets Http Method
     *
     * @param string $method
     *
     * @return self
     */
    public function setMethod($method = Request::METHOD_GET)
    {
        if (in_array($method, self::getMethods())) {
            $this->method = $method;
        }

        return $this;
    }

    /**
     * Send payload as application/x-www-form-urlencoded
     *
     * @return $this
     */
    public function setFormUrlencoded()
    {
        $this->addHeader('Content-Type', 'application/x-www-form-urlencoded');

        return $this;
    }

    /**
     * Send payload as JSON string
     */
    public function contentTypeIsJson()
    {
        $this->addHeader('Content-Type', 'application/json');

        return $this;
    }

    /**
     * Returns Http method used
     *
     * @return string
     */
    public function getMethod()
    {
        return $this->method;
    }

    /**
     * Returns available Http Methods
     *
     * @return array
     */
    public static function getMethods()
    {
        return Request::getMethods();
    }

    /**
     * Sets Request Entity
     *
     * @param RequestEntity $requestEntity
     *
     * @return self
     */
    public function setRequestEntity($requestEntity)
    {
        $this->requestEntity = $requestEntity;

        return $this;
    }

    /**
     * Sets ResponseInterface Entity
     *
     * @param ResponseEntity $responseEntity
     *
     * @return self
     */
    public function setResponseEntity($responseEntity)
    {
        $this->responseEntity = $responseEntity;

        return $this;
    }

    /**
     * Returns Request Entity used
     *
     * @return RequestEntity
     */
    public function getRequestEntity()
    {
        return $this->requestEntity;
    }

    /**
     * Returns ResponseInterface Entity used
     *
     * @return ResponseEntity
     */
    public function getResponseEntity()
    {
        return $this->responseEntity;
    }

    /**
     * Get Protocol version
     *
     * @return string
     */
    public function getProtocolVersion()
    {
        return $this->protocolVersion;
    }

    /**
     * Set Protocol Version
     *
     * @param string $protocolVersion
     *
     * @return self
     */
    public function setProtocolVersion($protocolVersion)
    {
        $this->protocolVersion = $protocolVersion;

        return $this;
    }

    /**
     * @return array
     */
    public function getDefaultHeaders()
    {
        return [
            'User-agent' => sprintf('payever PHP SDK v%s / cURL client', Engine::SDK_VERSION),
        ];
    }
}