wiki.techinc.nl/includes/api/ApiFormatPhp.php
Reedy 550d897d53 ApiFormatJson: Set PARAM_HELP_MSG_PER_VALUE for formatversion
Bug: T342638
Change-Id: I180350e9df08af61c2c01360e0f4bcfd1c764a20
2023-08-03 13:05:40 +00:00

76 lines
2.1 KiB
PHP

<?php
/**
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use Wikimedia\ParamValidator\ParamValidator;
/**
* API Serialized PHP output formatter
* @ingroup API
*/
class ApiFormatPhp extends ApiFormatBase {
public function getMimeType() {
return 'application/vnd.php.serialized';
}
public function execute() {
$params = $this->extractRequestParams();
switch ( $params['formatversion'] ) {
case 1:
$transforms = [
'BC' => [],
'Types' => [],
'Strip' => 'all',
];
break;
case 2:
case 'latest':
$transforms = [
'Types' => [],
'Strip' => 'all',
];
break;
default:
// Should have been caught during parameter validation
self::dieDebug( __METHOD__, 'Unknown value for \'formatversion\'' );
}
$this->printText( serialize( $this->getResult()->getResultData( null, $transforms ) ) );
}
public function getAllowedParams() {
return parent::getAllowedParams() + [
'formatversion' => [
ParamValidator::PARAM_TYPE => [ '1', '2', 'latest' ],
ParamValidator::PARAM_DEFAULT => '1',
ApiBase::PARAM_HELP_MSG => 'apihelp-php-param-formatversion',
ApiBase::PARAM_HELP_MSG_PER_VALUE => [
'1' => 'apihelp-php-paramvalue-formatversion-1',
'2' => 'apihelp-php-paramvalue-formatversion-2',
'latest' => 'apihelp-php-paramvalue-formatversion-latest',
],
],
];
}
}