1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 

<?php
/**
 * @author: stev leibelt <artodeto@bazzline.net>
 * @since: 2015-12-09
 */

namespace Net\Bazzline\Component\Curl\Request;

use Net\Bazzline\Component\Curl\Dispatcher\DispatcherInterface;
use Net\Bazzline\Component\Curl\HeaderLine\HeaderLineInterface;
use Net\Bazzline\Component\Curl\Option\OptionInterface;
use Net\Bazzline\Component\Curl\Response\Response;
use Net\Bazzline\Component\Toolbox\HashMap\Merge;

class Request
{
    //@see: http://developer.sugarcrm.com/2013/08/30/doing-put-and-delete-with-curl-in-php/
    const HTTP_METHOD_DELETE    = 'DELETE';
    const HTTP_METHOD_GET       = 'GET';
    const HTTP_METHOD_PATCH     = 'PATCH';
    const HTTP_METHOD_POST      = 'POST';
    const HTTP_METHOD_PUT       = 'PUT';

    /** @var array */
    private $defaultHeaderLines = [];

    /** @var array */
    private $defaultOptions = [];

    /** @var DispatcherInterface */
    private $dispatcher;

    /** @var array */
    private $headerLines = [];

    /** @var Merge */
    private $merge;

    /** @var array */
    private $options = [];

    /**
     * @param DispatcherInterface $dispatcher
     * @param Merge $merge
     * @param array $defaultHeaderLines
     *  <int> => <value>
     * @param array $defaultOptions
     *  either:
     *      <int> => <value>
     *  or:
     *      <identifier> => <value>
     */
    public function __construct(DispatcherInterface $dispatcher, Merge $merge, array $defaultHeaderLines = [], array $defaultOptions = [])
    {
        $this->defaultHeaderLines   = $defaultHeaderLines;
        $this->defaultOptions       = $defaultOptions;
        $this->dispatcher           = $dispatcher;
        $this->merge                = $merge;
    }

    /**
     * @return Request
     */
    public function __clone()
    {
        return new self(
            $this->dispatcher,
            $this->merge,
            $this->defaultHeaderLines,
            $this->defaultOptions
        );
    }

    /**
     * @param HeaderLineInterface $line
     */
    public function addHeaderLine(HeaderLineInterface $line)
    {
        $this->headerLines[] = $line->line();
    }

    /**
     * @param OptionInterface $option
     */
    public function addOption(OptionInterface $option)
    {
        $this->options[$option->identifier()] = $option->value();
    }

    /**
     * @param string $line - CURLOPT_* - see: http://php.net/manual/en/function.curl-setopt.php
     */
    public function addRawHeaderLine($line)
    {
        $this->headerLines[] = $line;
    }

    /**
     * @param string $key - CURLOPT_* - see: http://php.net/manual/en/function.curl-setopt.php
     * @param mixed $value
     */
    public function addRawOption($key, $value)
    {
        $this->options[$key] = $value;
    }

    /**
     * @param string $url
     * @param array $parameters
     * @return Response
     */
    public function get($url, array $parameters = [])
    {
        return $this->execute(
            $url,
            self::HTTP_METHOD_GET,
            $parameters,
            []
        );
    }

    /**
     * @param string $url
     * @param array $parameters
     * @param null|string|array $data
     * @return Response
     */
    public function post($url, array $parameters = [], $data = null)
    {
        return $this->execute(
            $url,
            self::HTTP_METHOD_POST,
            $parameters,
            $data
        );
    }

    /**
     * @param string $url
     * @param array $parameters
     * @param null|string|array $data
     * @return Response
     */
    public function put($url, array $parameters = [], $data = null)
    {
        return $this->execute(
            $url,
            self::HTTP_METHOD_PUT,
            $parameters,
            $data
        );
    }

    /**
     * @param string $url
     * @param array $parameters
     * @param null|string|array $data
     * @return Response
     */
    public function patch($url, array $parameters = [], $data = null)
    {
        return $this->execute(
            $url,
            self::HTTP_METHOD_PATCH,
            $parameters,
            $data
        );
    }

    /**
     * @param string $url
     * @param array $parameters
     * @param null|string|array $data
     * @return Response
     */
    public function delete($url, array $parameters = [], $data = null)
    {
        return $this->execute(
            $url,
            self::HTTP_METHOD_DELETE,
            $parameters,
            $data
        );
    }

    /**
     * @see: https://de.wikipedia.org/wiki/Representational_State_Transfer
    public function head($url)
    {
    }
    public function options($url)
    {
    }
    public function trace($url)
    {
    }
     */

    /**
     * @param bool|false $alsoTheDefaults
     */
    public function reset($alsoTheDefaults = false)
    {
        $this->headerLines  = [];
        $this->options      = [];

        if ($alsoTheDefaults) {
            $this->defaultHeaderLines   = [];
            $this->defaultOptions       = [];
        }
    }

    /**
     * @param array $options
     * @param mixed $data
     * @return array
     */
    private function addDataToTheOptionsIfDataIsValid(array $options, $data)
    {
        $isDataProvided = (!is_null($data));

        if ($isDataProvided) {
            $dataIsNotFromTypeScalar   = (!is_scalar($data));

            if ($dataIsNotFromTypeScalar) {
                $data = http_build_query($data);
            }

            $dataStringContainsContent = (strlen($data) > 0);

            if ($dataStringContainsContent) {
                $options[CURLOPT_POSTFIELDS] = $data; //@see: http://www.lornajane.net/posts/2009/putting-data-fields-with-php-curl
            }
        }

        return $options;
    }

    /**
     * @param array $parameters
     * @param string $url
     * @return string
     */
    private function addParametersToTheUrlIfParametersAreProvided(array $parameters, $url)
    {
        $areParametersProvided = (!empty($parameters));

        if ($areParametersProvided) {
            $parametersAsString     = http_build_query($parameters);
            $isParameterStringValid = (strlen($parametersAsString) > 0);

            if ($isParameterStringValid) {
                $urlWithParameters = $url . '?' . http_build_query($parameters);
            } else {
                $urlWithParameters = $url;
            }
        } else {
            $urlWithParameters = $url;
        }

        return $urlWithParameters;
    }

    /**
     * @param string $url
     * @param string $method
     * @param null|array $parameters
     * @param null|string|array $data
     * @return Response
     */
    private function execute($url, $method, array $parameters = [], $data = null)
    {
        //begin of dependencies
        $dispatcher             = $this->dispatcher;
        $merge                  = $this->merge;
        $headerLines            = $merge($this->headerLines, $this->defaultHeaderLines);
        $options                = $merge($this->options, $this->defaultOptions);
        $headerLines[]          = 'X-HTTP-Method-Override: ' . $method; //@see: http://tr.php.net/curl_setopt#109634
        //end of dependencies

        //begin of business logic
        $options[CURLOPT_CUSTOMREQUEST] = $method; //@see: http://tr.php.net/curl_setopt#109634
        $options[CURLOPT_HTTPHEADER]    = $headerLines;
        //@todo what about binary transfer?

        $options            = $this->addDataToTheOptionsIfDataIsValid($options, $data);
        $urlWithParameters  = $this->addParametersToTheUrlIfParametersAreProvided($parameters, $url);
        $response           = $dispatcher->dispatch($urlWithParameters, $options);
        //end of business logic

        return $response;
    }
}