Bee4\Transport\Message\Request\AbstractRequest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92.86%

Importance

Changes	12
Bugs	1	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setClient()	0	5	1
A	getUrl()	0	4	1
A	getOptions()	0	4	1
A	addOptions()	0	8	2
A	addOption()	0	10	2
A	hasOption()	0	4	1
	prepare()	0	1	?
A	send()	0	13	3
A	getStatusMessage()	0	5	2
A	getUserAgent()	0	4	1
A	setUserAgent()	0	6	1

<?php
/**
 * This file is part of the bee4/transport package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright Bee4 2015
 * @author  Stephane HULARD <s.hulard@chstudio.fr>
 * @package Bee4\Transport\Message\Request
 */

namespace Bee4\Transport\Message\Request;

use Bee4\Transport\Message\AbstractMessage;
use Bee4\Transport\Client;
use Bee4\Transport\Url;

/**
 * HTTP Request object
 * @package Bee4\Transport\Message\Request
 */
abstract class AbstractRequest extends AbstractMessage
{
    //Compatible SCHEME
    const HTTP = '/^http/';
    const FTP = '/^ftp/';
    const SSH = '/sftp|scp/';

    /**
     * Request UserAgent
     * Allow to identify the request initiator
     * @var string
     */
    protected $ua = "Bee4/Transport";

    /**
     * Current client instance
     * @var Client
     */
    protected $client;

    /**
     * specific cURL options for the current request
     * @var array
     */
    protected $options;

    /**
     * @var Url
     */
    protected $url;

    /**
     * Construct a new request object
     * @param Url $url
     * @param array $headers
     */
    public function __construct(Url $url, array $headers = [])
    {
        $this->url = $url;
        $this->options = [];
        $this->addHeaders($headers);
    }

    /**
     * Set the linked client
     * @param Client $client
     * @return AbstractRequest
     */
    public function setClient(Client $client)
    {
        $this->client = $client;
        return $this;
    }

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

    /**
     * cURL option collection accessor
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Add specifically curl option list to current request
     * @param array $options
     * @return AbstractRequest
     */
    public function addOptions(array $options)
    {
        foreach ($options as $name => $value) {
            $this->addOption($name, $value);
        }

        return $this;
    }

    /**
     * Add an option for current request
     * @param int $name
     * @param mixed $value
     * @return AbstractRequest
     */
    public function addOption($name, $value)
    {
        if ($name === CURLOPT_USERAGENT) {
            $this->ua = $value;
        }

        $this->options[$name] = $value;

        return $this;
    }

    /**
     * Check if an option exists
     * @param mixed $name
     * @return boolean
     */
    public function hasOption($name)
    {
        return isset($this->options[$name]);
    }

    /**
     * Prepare the request execution by adding specific cURL parameters
     */
    abstract protected function prepare();

    /**
     * Send method.
     * To send a request, a client must be linked
     * @return \Bee4\Transport\Message\Response
     */
    public function send()
    {
        if (!$this->client) {
            throw new \RuntimeException('A client must be set on the request');
        }

        if (!$this->hasOption(CURLOPT_URL)) {
            $this->addOption(CURLOPT_URL, $this->getUrl()->toString());
        }
        $this->prepare();

        return $this->client->send($this);
    }

    /**
     * Retrieve the status message for the current request based on STATUS_XXX constants
     * @param string $status
     * @return string
     */
    public function getStatusMessage($status)
    {
        $name = get_called_class().'::STATUS_'.$status;
        return defined($name)?constant($name):'';
    }

    /**
     * Get the client UA for all requests
     * @return string
     */
    public function getUserAgent()
    {
        return $this->ua;
    }

    /**
     * Set the client UA for current request
     * @param string $ua
     * @return AbstractRequest
     */
    public function setUserAgent($ua)
    {
        $this->addOption(CURLOPT_USERAGENT, $ua);

        return $this;
    }
}