PHP ApiFormatBase類代碼示例

 /**
  * 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;
 }

 /**
  * 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;
 }

 /**
  * 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 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();
 }

 public function __construct($main)
 {
     parent::__construct($main, 'feed');
 }

 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);
 }