class ClientFactory
Same name in other branches
- 9 core/lib/Drupal/Core/Http/ClientFactory.php \Drupal\Core\Http\ClientFactory
- 8.9.x core/lib/Drupal/Core/Http/ClientFactory.php \Drupal\Core\Http\ClientFactory
- 10 core/lib/Drupal/Core/Http/ClientFactory.php \Drupal\Core\Http\ClientFactory
Helper class to construct a HTTP client with Drupal specific config.
Hierarchy
- class \Drupal\Core\Http\ClientFactory
Expanded class hierarchy of ClientFactory
1 file declares its use of ClientFactory
- ClientFactoryTest.php in core/
tests/ Drupal/ Tests/ Core/ Http/ ClientFactoryTest.php
File
-
core/
lib/ Drupal/ Core/ Http/ ClientFactory.php, line 14
Namespace
Drupal\Core\HttpView source
class ClientFactory {
/**
* The handler stack.
*
* @var \GuzzleHttp\HandlerStack
*/
protected $stack;
/**
* Constructs a new ClientFactory instance.
*
* @param \GuzzleHttp\HandlerStack $stack
* The handler stack.
*/
public function __construct(HandlerStack $stack) {
$this->stack = $stack;
}
/**
* Constructs a new client object from some configuration.
*
* @param array $config
* The config for the client.
*
* @return \GuzzleHttp\Client
* The HTTP client.
*/
public function fromOptions(array $config = []) {
$default_config = [
// Security consideration: we must not use the certificate authority
// file shipped with Guzzle because it can easily get outdated if a
// certificate authority is hacked. Instead, we rely on the certificate
// authority file provided by the operating system which is more likely
// going to be updated in a timely fashion. This overrides the default
// path to the pem file bundled with Guzzle.
'verify' => TRUE,
'timeout' => 30,
'headers' => [
'User-Agent' => 'Drupal/' . \Drupal::VERSION . ' (+https://www.drupal.org/) ' . Utils::defaultUserAgent(),
],
'handler' => $this->stack,
// Security consideration: prevent Guzzle from using environment variables
// to configure the outbound proxy.
'proxy' => [
'http' => NULL,
'https' => NULL,
'no' => [],
],
];
$config = NestedArray::mergeDeep($default_config, Settings::get('http_client_config', []), $config);
return new Client($config);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ClientFactory::$stack | protected | property | The handler stack. |
ClientFactory::fromOptions | public | function | Constructs a new client object from some configuration. |
ClientFactory::__construct | public | function | Constructs a new ClientFactory instance. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.