FeedItem.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Feed;
 
use MediaWiki\Language\LanguageCode;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use MediaWiki\Utils\UrlUtils;
 
class FeedItem {
    public $title;
 
    public $description;
 
    public $url;
 
    public $date;
 
    public $author;
 
    public $uniqueId;
 
    public $comments;
 
    public $rssIsPermalink = false;
 
    protected UrlUtils $urlUtils;
 
    public function __construct(
        $title, $description, $url, $date = '', $author = '', $comments = ''
    ) {
        $this->title = $title;
        $this->description = $description;
        $this->url = $url;
        $this->uniqueId = $url;
        $this->date = $date;
        $this->author = $author;
        $this->comments = $comments;
        $this->urlUtils = MediaWikiServices::getInstance()->getUrlUtils();
    }
 
    public function xmlEncode( $string ) {
        $string = str_replace( "\r\n", "\n", $string );
        $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
 
        return htmlspecialchars( $string );
    }
 
    public function getUniqueID() {
        $id = $this->getUniqueIdUnescaped();
        if ( $id ) {
            return $this->xmlEncode( $id );
        }
    }
 
    public function getUniqueIdUnescaped(): ?string {
        if ( $this->uniqueId ) {
            return $this->urlUtils->expand( $this->uniqueId, PROTO_CURRENT );
        }
 
        return null;
    }
 
    public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
        $this->uniqueId = $uniqueId;
        $this->rssIsPermalink = $rssIsPermalink;
    }
 
    public function getTitle() {
        return $this->xmlEncode( $this->title );
    }
 
    public function getUrl() {
        return $this->xmlEncode( $this->url );
    }
 
    public function getUrlUnescaped() {
        return $this->url;
    }
 
    public function getDescription() {
        return $this->xmlEncode( $this->description );
    }
 
    public function getDescriptionUnescaped() {
        return $this->description;
    }
 
    public function getLanguage() {
        $languageCode = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::LanguageCode );
        return LanguageCode::bcp47( $languageCode );
    }
 
    public function getDate() {
        return $this->date;
    }
 
    public function getAuthor() {
        return $this->xmlEncode( $this->author );
    }
 
    public function getAuthorUnescaped() {
        return $this->author;
    }
 
    public function getComments() {
        return $this->xmlEncode( $this->comments );
    }
 
    public function getCommentsUnescaped() {
        return $this->comments;
    }
 
    public static function stripComment( $text ) {
        return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
    }
 
}
 
class_alias( FeedItem::class, 'FeedItem' );