MediaWiki  master
Go to the documentation of this file.
1 <?php
27 class ApiFormatPhp extends ApiFormatBase {
29  public function getMimeType() {
30  return 'application/vnd.php.serialized';
31  }
36  public function execute() {
37  $params = $this->extractRequestParams();
39  switch ( $params['formatversion'] ) {
40  case 1:
41  $transforms = [
42  'BC' => [],
43  'Types' => [],
44  'Strip' => 'all',
45  ];
46  break;
48  case 2:
49  case 'latest':
50  $transforms = [
51  'Types' => [],
52  'Strip' => 'all',
53  ];
54  break;
56  default:
57  // Should have been caught during parameter validation
58  $this->dieDebug( __METHOD__, 'Unknown value for \'formatversion\'' );
59  }
60  $text = serialize( $this->getResult()->getResultData( null, $transforms ) );
62  // T68776: OutputHandler::mangleFlashPolicy() avoids 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( 'MediaWiki\\OutputHandler::handle', ob_list_handlers(), true ) &&
68  preg_match( '/<\s*cross-domain-policy(?=\s|>)/i', $text )
69  ) {
70  $this->dieWithError( 'apierror-formatphp', 'internalerror' );
71  }
73  $this->printText( $text );
74  }
76  public function getAllowedParams() {
77  $ret = parent::getAllowedParams() + [
78  'formatversion' => [
79  ApiBase::PARAM_TYPE => [ '1', '2', 'latest' ],
80  ApiBase::PARAM_DFLT => '1',
81  ApiBase::PARAM_HELP_MSG => 'apihelp-php-param-formatversion',
82  ],
83  ];
84  return $ret;
85  }
86 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
API Serialized PHP output formatter.
Get the result object.
Definition: ApiBase.php:640
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:1971
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
printText( $text)
Append text to the output buffer.
This is the abstract base class for API formatters.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
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
SecurityCheck-XSS Output type is not text/html
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2212