Page MenuHomeWickedGov Phorge
Files F6027627

ApiFormatFeedWrapper.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiFormatFeedWrapper.php
View Options

<?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
*/
namespace MediaWiki\Api;
use MediaWiki\Feed\ChannelFeed;
use MediaWiki\Feed\FeedItem;
/**
* This printer is used to wrap an instance of the Feed class
* @ingroup API
*/
class ApiFormatFeedWrapper extends ApiFormatBase {
public function __construct( ApiMain $main ) {
parent::__construct( $main, 'feed' );
}
/**
* Call this method to initialize output data. See execute()
* @param ApiResult $result
* @param FeedItem $feed An instance of one of the $wgFeedClasses classes
* @param FeedItem[] $feedItems
*/
public static function setResult( $result, $feed, $feedItems ) {
// Store output in the Result data.
// This way we can check during execution if any error has occurred
// Disable size checking for this because we can't continue
// cleanly; size checking would cause more problems than it'd
// solve
$result->addValue( null, '_feed', $feed, ApiResult::NO_VALIDATE );
$result->addValue( null, '_feeditems', $feedItems, ApiResult::NO_VALIDATE );
}
/**
* Feed does its own headers
*
* @return null
*/
public function getMimeType() {
return null;
}
/**
* MediaWiki\Feed\ChannelFeed doesn't give us a method to print errors in a friendly
* manner, so just punt errors to the default printer.
* @return bool
*/
public function canPrintErrors() {
return false;
}
/**
* 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 MediaWiki\Feed\FeedItem instances
* @param bool $unused
*/
public function initPrinter( $unused = false ) {
parent::initPrinter( $unused );
if ( $this->isDisabled() ) {
return;
}
$data = $this->getResult()->getResultData();
if ( isset( $data['_feed'] ) && isset( $data['_feeditems'] ) ) {
/** @var ChannelFeed $feed */
$feed = $data['_feed'];
$feed->httpHeaders();
} else {
// Error has occurred, print something useful
ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
}
}
/**
* 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 MediaWiki\Feed\FeedItem instances
*/
public function execute() {
$data = $this->getResult()->getResultData();
if ( isset( $data['_feed'] ) && isset( $data['_feeditems'] ) ) {
/** @var ChannelFeed $feed */
$feed = $data['_feed'];
$items = $data['_feeditems'];
// execute() needs to pass strings to $this->printText, not produce output itself.
ob_start();
$feed->outHeader();
foreach ( $items as & $item ) {
$feed->outItem( $item );
}
$feed->outFooter();
$this->printText( ob_get_clean() );
} else {
// Error has occurred, print something useful
ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
}
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiFormatFeedWrapper::class, 'ApiFormatFeedWrapper' );

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 16:59 (5 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
cf/c4/e6fe1ff445ac6c7801146a20d607
Default Alt Text
ApiFormatFeedWrapper.php (3 KB)

Event Timeline