MediaWiki  1.28.1
ApiFormatPhp.php
Go to the documentation of this file.
1 <?php
31 class ApiFormatPhp extends ApiFormatBase {
32 
33  public function getMimeType() {
34  return 'application/vnd.php.serialized';
35  }
36 
37  public function execute() {
38  $params = $this->extractRequestParams();
39 
40  switch ( $params['formatversion'] ) {
41  case 1:
42  $transforms = [
43  'BC' => [],
44  'Types' => [],
45  'Strip' => 'all',
46  ];
47  break;
48 
49  case 2:
50  case 'latest':
51  $transforms = [
52  'Types' => [],
53  'Strip' => 'all',
54  ];
55  break;
56 
57  default:
58  $this->dieUsage( __METHOD__ . ': Unknown value for \'formatversion\'', 'unknownformatversion' );
59  }
60  $text = serialize( $this->getResult()->getResultData( null, $transforms ) );
61 
62  // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
63  // Flash, but what it does isn't friendly for the API. There's nothing
64  // we can do here that isn't actively broken in some manner, so let's
65  // just be broken in a useful manner.
66  if ( $this->getConfig()->get( 'MangleFlashPolicy' ) &&
67  in_array( 'wfOutputHandler', ob_list_handlers(), true ) &&
68  preg_match( '/<\s*cross-domain-policy(?=\s|>)/i', $text )
69  ) {
70  $this->dieUsage(
71  'This response cannot be represented using format=php. ' .
72  'See https://phabricator.wikimedia.org/T68776',
73  'internalerror'
74  );
75  }
76 
77  $this->printText( $text );
78  }
79 
80  public function getAllowedParams() {
81  $ret = parent::getAllowedParams() + [
82  'formatversion' => [
83  ApiBase::PARAM_TYPE => [ 1, 2, 'latest' ],
85  ApiBase::PARAM_HELP_MSG => 'apihelp-php-param-formatversion',
86  ],
87  ];
88  return $ret;
89  }
90 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
API Serialized PHP output formatter.
getResult()
Get the result object.
Definition: ApiBase.php:584
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 noclasses & $ret
Definition: hooks.txt:1936
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
This is the abstract base class for API formatters.
printText($text)
Append text to the output buffer.
getConfig()
Get the Config object.
$params
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1585
serialize()
Definition: ApiMessage.php:94