public function getDescription()
{
if ($this->mIsRaw) {
return 'Output data with the debugging elements in JSON format' . parent::getDescription();
}
return 'Output data in JSON format' . parent::getDescription();
}
public function __construct( $main, $format ) {
parent :: __construct( $main, $format );
$this->dmRecords = array();
$this->languages = array();
$this->excluded = array();
$this->errorMessages = array();
}
protected function getDescription()
{
if ($this->mIsRaw) {
return 'Output data with the debuging elements in JSON format' . parent::getDescription();
} else {
return 'Output data in JSON format' . parent::getDescription();
}
}
public function closePrinter()
{
$data = $this->getResult()->getResultData();
if (isset($data['error'])) {
$this->errorFallback->closePrinter();
} else {
parent::closePrinter();
}
}
public function closePrinter()
{
if ($this->isDisabled()) {
return;
}
if ($this->file) {
ob_clean();
readfile($this->file);
} else {
return parent::closePrinter();
}
}
public function __construct(ApiMain $main, $format)
{
parent::__construct($main, $format);
$this->isRaw = $format === 'rawfm';
if ($this->getMain()->getCheck('callback')) {
# T94015: jQuery appends a useless '_' parameter in jsonp mode.
# Mark the parameter as used in that case to avoid a warning that's
# outside the control of the end user.
# (and do it here because ApiMain::reportUnusedParams() gets called
# before our ::execute())
$this->getMain()->getCheck('_');
}
}
/**
* This class expects the result data to be in a custom format set by self::setResult()
* $result['_feed'] - an instance of one of the $wgFeedClasses classes
* $result['_feeditems'] - an array of FeedItem instances
*/
public function initPrinter($unused = false)
{
parent::initPrinter($unused);
if ($this->isDisabled()) {
return;
}
$data = $this->getResult()->getResultData();
if (isset($data['_feed']) && isset($data['_feeditems'])) {
$data['_feed']->httpHeaders();
} else {
// Error has occurred, print something useful
ApiBase::dieDebug(__METHOD__, 'Invalid feed class/item');
}
}
/**
* Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
* for example in case of spelling mistakes or a missing 'g' prefix for generators.
*/
protected function reportUnusedParams()
{
$paramsUsed = $this->getParamsUsed();
$allParams = $this->getRequest()->getValueNames();
if (!$this->mInternalMode) {
// Printer has not yet executed; don't warn that its parameters are unused
$printerParams = array_map([$this->mPrinter, 'encodeParamName'], array_keys($this->mPrinter->getFinalParams() ?: []));
$unusedParams = array_diff($allParams, $paramsUsed, $printerParams);
} else {
$unusedParams = array_diff($allParams, $paramsUsed);
}
if (count($unusedParams)) {
$s = count($unusedParams) > 1 ? 's' : '';
$this->setWarning("Unrecognized parameter{$s}: '" . implode($unusedParams, "', '") . "'");
}
}
public function getDescription()
{
return 'Output data in serialized PHP format' . parent::getDescription();
}
/**
* Returns the version information of this file, plus it includes
* the versions for all files that are not callable proper API modules
*/
public function getVersion()
{
$vers = array();
$vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
$vers[] = __CLASS__ . ': $Id: ApiMain.php 70066 2010-07-28 05:52:32Z tstarling $';
$vers[] = ApiBase::getBaseVersion();
$vers[] = ApiFormatBase::getBaseVersion();
$vers[] = ApiQueryBase::getBaseVersion();
return $vers;
}
public function __construct($main)
{
parent::__construct($main, 'feed');
}
/**
* Returns the version information of this file, plus it includes
* the versions for all files that are not callable proper API modules
*/
public function getVersion()
{
$vers = array();
$vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
$vers[] = __CLASS__ . ': $Id: ApiMain.php 69990 2010-07-27 08:44:08Z tstarling $';
$vers[] = ApiBase::getBaseVersion();
$vers[] = ApiFormatBase::getBaseVersion();
$vers[] = ApiQueryBase::getBaseVersion();
$vers[] = ApiFormatFeedWrapper::getVersion();
// not accessible with format=xxx
return $vers;
}
public function __construct(ApiMain $main, $format)
{
parent::__construct($main, $format);
$this->isRaw = $format === 'rawfm';
}
/**
* Sets whether the pretty-printer should format *bold* and $italics$
*
* @deprecated since 1.25
* @param bool $help
*/
public function setHelp($help = true)
{
wfDeprecated(__METHOD__, '1.25');
$this->mPrinter->setHelp($help);
}
public function getDescription()
{
return 'Output data in WDDX format' . parent::getDescription();
}
public function getAllowedParams()
{
if ($this->isRaw) {
return parent::getAllowedParams();
}
$ret = parent::getAllowedParams() + array('callback' => array(ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback'), 'utf8' => array(ApiBase::PARAM_DFLT => false, ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8'), 'ascii' => array(ApiBase::PARAM_DFLT => false, ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii'), 'formatversion' => array(ApiBase::PARAM_TYPE => array(1, 2, 'latest'), ApiBase::PARAM_DFLT => 1, ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion'));
return $ret;
}
/**
* Returns the version information of this file, plus it includes
* the versions for all files that are not callable proper API modules
*/
public function getVersion()
{
$vers = array();
$vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
$vers[] = __CLASS__ . ': $Id: ApiMain.php 50834 2009-05-20 20:10:47Z catrope $';
$vers[] = ApiBase::getBaseVersion();
$vers[] = ApiFormatBase::getBaseVersion();
$vers[] = ApiQueryBase::getBaseVersion();
$vers[] = ApiFormatFeedWrapper::getVersion();
// not accessible with format=xxx
return $vers;
}
protected function getDescription()
{
return 'Output data in XML format' . parent::getDescription();
}
/**
* Constructor
* @param $main ApiMain object
* @param $errorFallback ApiFormatBase object to fall back on for errors
*/
public function __construct($main, $errorFallback)
{
parent::__construct($main, 'raw');
$this->mErrorFallback = $errorFallback;
}
public function getAllowedParams()
{
$ret = parent::getAllowedParams() + array('formatversion' => array(ApiBase::PARAM_TYPE => array(1, 2, 'latest'), ApiBase::PARAM_DFLT => 1, ApiBase::PARAM_HELP_MSG => 'apihelp-php-param-formatversion'));
return $ret;
}
public function getAllowedParams()
{
return parent::getAllowedParams() + ['xslt' => [ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-xslt'], 'includexmlnamespace' => [ApiBase::PARAM_DFLT => false, ApiBase::PARAM_HELP_MSG => 'apihelp-xml-param-includexmlnamespace']];
}
public function getDescription()
{
return 'Output nothing' . parent::getDescription();
}
public function getDescription()
{
return 'Output data in PHP\'s var_export() format' . parent::getDescription();
}
public function __construct($main, $format)
{
parent::__construct($main, $format);
}
/**
* Returns the version information of this file, plus it includes
* the versions for all files that are not callable proper API modules
*
* @return array
*/
public function getVersion()
{
$vers = array();
$vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
$vers[] = __CLASS__ . ': $Id$';
$vers[] = ApiBase::getBaseVersion();
$vers[] = ApiFormatBase::getBaseVersion();
$vers[] = ApiQueryBase::getBaseVersion();
return $vers;
}
public function getDescription()
{
return 'DEPRECATED! Output data in PHP\'s var_dump() format' . parent::getDescription();
}
public function getDescription()
{
return 'Output data in PHP\'s print_r() format' . parent::getDescription();
}
/**
* Sets whether the pretty-printer should format *bold* and $italics$
*
* @param $help bool
*/
public function setHelp($help = true)
{
$this->mPrinter->setHelp($help);
}
/**
* Returns the version information of this file, plus it includes
* the versions for all files that are not callable proper API modules
*/
public function getVersion()
{
$vers = array();
$vers[] = 'MediaWiki ' . SpecialVersion::getVersion();
$vers[] = __CLASS__ . ': $Id: ApiMain.php 24494 2007-07-31 17:53:37Z yurik $';
$vers[] = ApiBase::getBaseVersion();
$vers[] = ApiFormatBase::getBaseVersion();
$vers[] = ApiQueryBase::getBaseVersion();
$vers[] = ApiFormatFeedWrapper::getVersion();
// not accessible with format=xxx
return $vers;
}
public function getDescription()
{
return 'DEPRECATED! Output data in YAML format' . ApiFormatBase::getDescription();
}