ApiFormatFeedWrapper.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Feed\ChannelFeed;
use MediaWiki\Feed\FeedItem;
 
class ApiFormatFeedWrapper extends ApiFormatBase {
 
    public function __construct( ApiMain $main ) {
        parent::__construct( $main, 'feed' );
    }
 
    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 );
    }
 
    public function getMimeType() {
        return null;
    }
 
    public function canPrintErrors() {
        return false;
    }
 
    public function initPrinter( $unused = false ) {
        parent::initPrinter( $unused );
 
        if ( $this->isDisabled() ) {
            return;
        }
 
        $data = $this->getResult()->getResultData();
        if ( isset( $data['_feed'] ) && isset( $data['_feeditems'] ) ) {
            $feed = $data['_feed'];
            '@phan-var ChannelFeed $feed';
 
            $feed->httpHeaders();
        } else {
            // Error has occurred, print something useful
            ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
        }
    }
 
    public function execute() {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['_feed'] ) && isset( $data['_feeditems'] ) ) {
            $feed = $data['_feed'];
            $items = $data['_feeditems'];
 
            '@phan-var ChannelFeed $feed';
            '@phan-var FeedItem[] $items';
 
            // 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' );
        }
    }
}
 
class_alias( ApiFormatFeedWrapper::class, 'ApiFormatFeedWrapper' );