public \Joomla\CMS\Http\Response
request
(mixed $method, \Joomla\Uri\UriInterface $uri, mixed $data = null, array $headers = [], mixed $timeout = null, mixed $userAgent = null)
/**
* 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 UriInterface $uri 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.
* @param string $userAgent The optional user agent string to send with the request.
*
* @return Response
*
* @since 1.7.3
* @throws \RuntimeException
*/
public function request($method, UriInterface $uri, $data = null, array $headers = [], $timeout = null, $userAgent = null)
{
// Create the stream context options array with the required method offset.
$options = array('method' => strtoupper($method));
// If data exists let's encode it and make sure our Content-Type header is set.
if (isset($data)) {
// If the data is a scalar value simply add it to the stream context options.
if (is_scalar($data)) {
$options['content'] = $data;
} else {
$options['content'] = http_build_query($data);
}
if (!isset($headers['Content-Type'])) {
$headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=utf-8';
}
// Add the relevant headers.
$headers['Content-Length'] = \strlen($options['content']);
}
// If an explicit timeout is given user it.
if (isset($timeout)) {
$options['timeout'] = (int) $timeout;
}
// If an explicit user agent is given use it.
if (isset($userAgent)) {
$options['user_agent'] = $userAgent;
}
// Ignore HTTP errors so that we can capture them.
$options['ignore_errors'] = 1;
// Follow redirects.
$options['follow_location'] = (int) $this->getOption('follow_location', 1);
// Set any custom transport options
foreach ($this->getOption('transport.stream', array()) as $key => $value) {
$options[$key] = $value;
}
// Add the proxy configuration, if any.
$app = Factory::getApplication();
if ($app->get('proxy_enable')) {
$options['proxy'] = $app->get('proxy_host') . ':' . $app->get('proxy_port');
$options['request_fulluri'] = true;
// Put any required authorization into the headers array to be handled later
// @todo: do we need to support any auth type other than Basic?
if ($user = $app->get('proxy_user')) {
$auth = base64_encode($app->get('proxy_user') . ':' . $app->get('proxy_pass'));
$headers['Proxy-Authorization'] = 'Basic ' . $auth;
}
}
// Build the headers string for the request.
$headerEntries = array();
if (isset($headers)) {
foreach ($headers as $key => $value) {
$headerEntries[] = $key . ': ' . $value;
}
// Add the headers string into the stream context options array.
$options['header'] = implode("\r\n", $headerEntries);
}
// Get the current context options.
$contextOptions = stream_context_get_options(stream_context_get_default());
// Add our options to the current ones, if any.
$contextOptions['http'] = isset($contextOptions['http']) ? array_merge($contextOptions['http'], $options) : $options;
// Create the stream context for the request.
$context = stream_context_create(array('http' => $options, 'ssl' => array('verify_peer' => true, 'cafile' => $this->getOption('stream.certpath', CaBundle::getBundledCaBundlePath()), 'verify_depth' => 5, 'verify_peer_name' => true)));
// Authentication, if needed
if ($uri instanceof Uri && $this->getOption('userauth') && $this->getOption('passwordauth')) {
$uri->setUser($this->getOption('userauth'));
$uri->setPass($this->getOption('passwordauth'));
}
// Capture PHP errors
$php_errormsg = '';
$track_errors = ini_get('track_errors');
ini_set('track_errors', true);
// Open the stream for reading.
$stream = @fopen((string) $uri, 'r', false, $context);
if (!$stream) {
if (!$php_errormsg) {
// Error but nothing from php? Create our own
$php_errormsg = sprintf('Could not connect to resource: %s', $uri);
}
// Restore error tracking to give control to the exception handler
ini_set('track_errors', $track_errors);
throw new \RuntimeException($php_errormsg);
}
// Restore error tracking to what it was before.
ini_set('track_errors', $track_errors);
// Get the metadata for the stream, including response headers.
$metadata = stream_get_meta_data($stream);
// Get the contents from the stream.
$content = stream_get_contents($stream);
// Close the stream.
fclose($stream);
if (isset($metadata['wrapper_data']['headers'])) {
$headers = $metadata['wrapper_data']['headers'];
} elseif (isset($metadata['wrapper_data'])) {
$headers = $metadata['wrapper_data'];
} else {
$headers = array();
}
return $this->getResponse($headers, $content);
}