338 lines
9.1 KiB
PHP
338 lines
9.1 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Platform
|
|
* @subpackage HTTP
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
defined('JPATH_PLATFORM') or die;
|
|
|
|
/**
|
|
* HTTP client class.
|
|
*
|
|
* @package Joomla.Platform
|
|
* @subpackage HTTP
|
|
* @since 11.3
|
|
*/
|
|
class JHttp
|
|
{
|
|
/**
|
|
* @var JRegistry Options for the HTTP client.
|
|
* @since 11.3
|
|
*/
|
|
protected $options;
|
|
|
|
/**
|
|
* @var JHttpTransport The HTTP transport object to use in sending HTTP requests.
|
|
* @since 11.3
|
|
*/
|
|
protected $transport;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param JRegistry $options Client options object. If the registry contains any headers.* elements,
|
|
* these will be added to the request headers.
|
|
* @param JHttpTransport $transport The HTTP transport object.
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function __construct(JRegistry $options = null, JHttpTransport $transport = null)
|
|
{
|
|
$this->options = isset($options) ? $options : new JRegistry;
|
|
$this->transport = isset($transport) ? $transport : JHttpFactory::getAvailableDriver($this->options);
|
|
}
|
|
|
|
/**
|
|
* Get an option from the HTTP client.
|
|
*
|
|
* @param string $key The name of the option to get.
|
|
*
|
|
* @return mixed The option value.
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function getOption($key)
|
|
{
|
|
return $this->options->get($key);
|
|
}
|
|
|
|
/**
|
|
* 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 JHttp This object for method chaining.
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function setOption($key, $value)
|
|
{
|
|
$this->options->set($key, $value);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Method to send the OPTIONS command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function options($url, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('OPTIONS', new JUri($url), null, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the HEAD command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function head($url, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('HEAD', new JUri($url), null, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the GET command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function get($url, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('GET', new JUri($url), null, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the POST command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param mixed $data Either an associative array or a string to be sent with the request.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function post($url, $data, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('POST', new JUri($url), $data, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the PUT command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param mixed $data Either an associative array or a string to be sent with the request.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function put($url, $data, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('PUT', new JUri($url), $data, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the DELETE command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function delete($url, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('DELETE', new JUri($url), null, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the TRACE command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 11.3
|
|
*/
|
|
public function trace($url, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('TRACE', new JUri($url), null, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
|
|
/**
|
|
* Method to send the PATCH command to the server.
|
|
*
|
|
* @param string $url Path to the resource.
|
|
* @param mixed $data Either an associative array or a string to be sent with the request.
|
|
* @param array $headers An array of name-value pairs to include in the header of the request.
|
|
* @param integer $timeout Read timeout in seconds.
|
|
*
|
|
* @return JHttpResponse
|
|
*
|
|
* @since 12.2
|
|
*/
|
|
public function patch($url, $data, array $headers = null, $timeout = null)
|
|
{
|
|
// Look for headers set in the options.
|
|
$temp = (array) $this->options->get('headers');
|
|
foreach ($temp as $key => $val)
|
|
{
|
|
if (!isset($headers[$key]))
|
|
{
|
|
$headers[$key] = $val;
|
|
}
|
|
}
|
|
|
|
// Look for timeout set in the options.
|
|
if ($timeout === null && $this->options->exists('timeout'))
|
|
{
|
|
$timeout = $this->options->get('timeout');
|
|
}
|
|
|
|
return $this->transport->request('PATCH', new JUri($url), $data, $headers, $timeout, $this->options->get('userAgent', null));
|
|
}
|
|
}
|