Joomla\Http\Http

Complexity

Total Complexity

25

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	24	5
A	getOption()	0	4	2
A	setOption()	0	6	1
A	options()	0	4	1
A	head()	0	4	1
A	get()	0	4	1
A	post()	0	4	1
A	put()	0	4	1
A	delete()	0	4	1
A	trace()	0	4	1
A	patch()	0	4	1
D	makeTransportRequest()	0	36	9

<?php
/**
 * Part of the Joomla Framework Http Package
 *
 * @copyright  Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\Http;

use Joomla\Uri\Uri;
use Joomla\Uri\UriInterface;

/**
 * HTTP client class.
 *
 * @since  1.0
 */
class Http
{
	/**
	 * Options for the HTTP client.
	 *
	 * @var    array|\ArrayAccess
	 * @since  1.0
	 */
	protected $options;

	/**
	 * The HTTP transport object to use in sending HTTP requests.
	 *
	 * @var    TransportInterface
	 * @since  1.0
	 */
	protected $transport;

	/**
	 * Constructor.
	 *
	 * @param   array|\ArrayAccess  $options    Client options array. If the registry contains any headers.* elements,
	 *                                          these will be added to the request headers.
	 * @param   TransportInterface  $transport  The HTTP transport object.
	 *
	 * @since   1.0
	 * @throws  \InvalidArgumentException
	 */
	public function __construct($options = array(), TransportInterface $transport = null)
	{
		if (!is_array($options) && !($options instanceof \ArrayAccess))
		{
			throw new \InvalidArgumentException(
				'The options param must be an array or implement the ArrayAccess interface.'
			);
		}

		$this->options = $options;

		if (!isset($transport))
		{
			$transport = HttpFactory::getAvailableDriver($this->options);
		}

		// Ensure the transport is a TransportInterface instance or bail out
		if (!($transport instanceof TransportInterface))
		{
			throw new \InvalidArgumentException('A valid TransportInterface object was not set.');
		}

		$this->transport = $transport;
	}

	/**
	 * Get an option from the HTTP client.
	 *
	 * @param   string  $key  The name of the option to get.
	 *
	 * @return  mixed  The option value.
	 *
	 * @since   1.0
	 */
	public function getOption($key)
	{
		return isset($this->options[$key]) ? $this->options[$key] : null;
	}

	/**
	 * Set an option for the HTTP client.
	 *
	 * @param   string  $key    The name of the option to set.
	 * @param   mixed   $value  The option value to set.
	 *
	 * @return  Http  This object for method chaining.
	 *
	 * @since   1.0
	 */
	public function setOption($key, $value)
	{
		$this->options[$key] = $value;

		return $this;
	}

	/**
	 * Method to send the OPTIONS command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function options($url, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('OPTIONS', $url, null, $headers, $timeout);
	}

	/**
	 * Method to send the HEAD command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function head($url, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('HEAD', $url, null, $headers, $timeout);
	}

	/**
	 * Method to send the GET command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function get($url, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('GET', $url, null, $headers, $timeout);
	}

	/**
	 * Method to send the POST command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   mixed                $data     Either an associative array or a string to be sent with the request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function post($url, $data, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('POST', $url, $data, $headers, $timeout);
	}

	/**
	 * Method to send the PUT command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   mixed                $data     Either an associative array or a string to be sent with the request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function put($url, $data, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('PUT', $url, $data, $headers, $timeout);
	}

	/**
	 * Method to send the DELETE command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 * @param   mixed                $data     Either an associative array or a string to be sent with the request.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function delete($url, array $headers = array(), $timeout = null, $data = null)
	{
		return $this->makeTransportRequest('DELETE', $url, $data, $headers, $timeout);
	}

	/**
	 * Method to send the TRACE command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function trace($url, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('TRACE', $url, null, $headers, $timeout);
	}

	/**
	 * Method to send the PATCH command to the server.
	 *
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   mixed                $data     Either an associative array or a string to be sent with the request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 */
	public function patch($url, $data, array $headers = array(), $timeout = null)
	{
		return $this->makeTransportRequest('PATCH', $url, $data, $headers, $timeout);
	}

	/**
	 * Send a request to the server and return a Response object with the response.
	 *
	 * @param   string               $method   The HTTP method for sending the request.
	 * @param   string|UriInterface  $url      The URI to the resource to request.
	 * @param   mixed                $data     Either an associative array or a string to be sent with the request.
	 * @param   array                $headers  An array of request headers to send with the request.
	 * @param   integer              $timeout  Read timeout in seconds.
	 *
	 * @return  Response
	 *
	 * @since   1.0
	 * @throws  \InvalidArgumentException
	 */
	protected function makeTransportRequest($method, $url, $data = null, array $headers = array(), $timeout = null)
	{
		// Look for headers set in the options.
		if (isset($this->options['headers']))
		{
			$temp = (array) $this->options['headers'];

			foreach ($temp as $key => $val)
			{
				if (!isset($headers[$key]))
				{
					$headers[$key] = $val;
				}
			}
		}

		// Look for timeout set in the options.
		if ($timeout === null && isset($this->options['timeout']))
		{
			$timeout = $this->options['timeout'];
		}

		$userAgent = isset($this->options['userAgent']) ? $this->options['userAgent'] : null;

		// Convert to a Uri object if we were given a string
		if (is_string($url))
		{
			$url = new Uri($url);
		}
		elseif (!($url instanceof UriInterface))

The class Joomla\Uri\UriInterface does not exist. Did you forget a USE statement, or did you not list all dependencies?

		{
			throw new \InvalidArgumentException(sprintf('A string or UriInterface object must be provided, a "%s" was provided.', gettype($url)));
		}

		return $this->transport->request($method, $url, $data, $headers, $timeout, $userAgent);
	}
}