MediaWiki  1.33.0
HttpRequestFactory.php
Go to the documentation of this file.
1 <?php
20 namespace MediaWiki\Http;
21 
23 use DomainException;
24 use Http;
30 
35 
45  public function create( $url, array $options = [], $caller = __METHOD__ ) {
46  if ( !Http::$httpEngine ) {
47  Http::$httpEngine = 'guzzle';
48  } elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
49  throw new DomainException( __METHOD__ . ': curl (https://secure.php.net/curl) is not ' .
50  'installed, but Http::$httpEngine is set to "curl"' );
51  }
52 
53  if ( !isset( $options['logger'] ) ) {
54  $options['logger'] = LoggerFactory::getInstance( 'http' );
55  }
56 
57  switch ( Http::$httpEngine ) {
58  case 'guzzle':
59  return new GuzzleHttpRequest( $url, $options, $caller, Profiler::instance() );
60  case 'curl':
61  return new CurlHttpRequest( $url, $options, $caller, Profiler::instance() );
62  case 'php':
63  if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
64  throw new DomainException( __METHOD__ . ': allow_url_fopen ' .
65  'needs to be enabled for pure PHP http requests to ' .
66  'work. If possible, curl should be used instead. See ' .
67  'https://secure.php.net/curl.'
68  );
69  }
70  return new PhpHttpRequest( $url, $options, $caller, Profiler::instance() );
71  default:
72  throw new DomainException( __METHOD__ . ': The setting of Http::$httpEngine is not valid.' );
73  }
74  }
75 
81  public function canMakeRequests() {
82  return function_exists( 'curl_init' ) || wfIniGetBool( 'allow_url_fopen' );
83  }
84 
85 }
Http\$httpEngine
static $httpEngine
Definition: Http.php:28
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:62
MediaWiki\Http\HttpRequestFactory\canMakeRequests
canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen()
Definition: HttpRequestFactory.php:81
MediaWiki\Logger\LoggerFactory\getInstance
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
Definition: LoggerFactory.php:92
MediaWiki\Http\HttpRequestFactory
Factory creating MWHttpRequest objects.
Definition: HttpRequestFactory.php:34
MediaWiki\Http
Definition: HttpRequestFactory.php:20
CurlHttpRequest
MWHttpRequest implemented using internal curl compiled into PHP.
Definition: CurlHttpRequest.php:24
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
GuzzleHttpRequest
MWHttpRequest implemented using the Guzzle library.
Definition: GuzzleHttpRequest.php:39
Profiler
Profiler base class that defines the interface and some trivial functionality.
Definition: Profiler.php:33
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
MWHttpRequest
This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for h...
Definition: MWHttpRequest.php:32
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2104
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1985
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
PhpHttpRequest
Definition: PhpHttpRequest.php:21
MediaWiki\Http\HttpRequestFactory\create
create( $url, array $options=[], $caller=__METHOD__)
Generate a new MWHttpRequest object.
Definition: HttpRequestFactory.php:45
Http
Various HTTP related functions.
Definition: Http.php:27