Page MenuHomeWickedGov Phorge
Files F1426671

FeedItem.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

FeedItem.php
View Options

<?php
/**
* Copyright © 2004 Brooke Vibber <bvibber@wikimedia.org>
* https://www.mediawiki.org/
*
* 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\Feed;
use MediaWiki\Language\LanguageCode;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use MediaWiki\Utils\UrlUtils;
/**
* @defgroup Feed Feed
*/
/**
* A base class for outputting syndication feeds (e.g. RSS and other formats).
*
* @ingroup Feed
*/
class FeedItem {
/** @var Title */
public $title;
/** @var string */
public $description;
/** @var string */
public $url;
/** @var string */
public $date;
/** @var string */
public $author;
/** @var string */
public $uniqueId;
/** @var string */
public $comments;
/** @var bool */
public $rssIsPermalink = false;
protected UrlUtils $urlUtils;
/**
* @param string|Title $title Item's title
* @param string $description
* @param string $url URL uniquely designating the item.
* @param string $date Item's date
* @param string $author Author's user name
* @param string $comments
*/
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();
}
/**
* Encode $string so that it can be safely embedded in a XML document
*
* @param string $string String to encode
*
* @return string
*/
public function xmlEncode( $string ) {
$string = str_replace( "\r\n", "\n", $string );
$string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
return htmlspecialchars( $string );
}
/**
* Encode $string so that it can be safely embedded in a XML document,
* returning `null` if $string was `null`.
* @since 1.44 (also backported to 1.39.12, 1.42.6 and 1.43.1)
*/
public function xmlEncodeNullable( ?string $string ): ?string {
return $string !== null ? $this->xmlEncode( $string ) : null;
}
/**
* Get the unique id of this item; already xml-encoded
*
* @return string
*/
public function getUniqueID() {
$id = $this->getUniqueIdUnescaped();
if ( $id ) {
return $this->xmlEncode( $id );
}
}
/**
* Get the unique id of this item, without any escaping
*
* @return string|null
*/
public function getUniqueIdUnescaped(): ?string {
if ( $this->uniqueId ) {
return $this->urlUtils->expand( $this->uniqueId, PROTO_CURRENT );
}
return null;
}
/**
* Set the unique id of an item
*
* @param string $uniqueId Unique id for the item
* @param bool $rssIsPermalink Set to true if the guid (unique id) is a permalink (RSS feeds only)
*/
public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
$this->uniqueId = $uniqueId;
$this->rssIsPermalink = $rssIsPermalink;
}
/**
* Get the title of this item; already xml-encoded
*
* @return string
*/
public function getTitle() {
return $this->xmlEncode( $this->title );
}
/**
* Get the URL of this item; already xml-encoded
*
* @return string
*/
public function getUrl() {
return $this->xmlEncode( $this->url );
}
/** Get the URL of this item without any escaping
*
* @return string
*/
public function getUrlUnescaped() {
return $this->url;
}
/**
* Get the description of this item; already xml-encoded
*
* @return string
*/
public function getDescription() {
return $this->xmlEncode( $this->description );
}
/**
* Get the description of this item without any escaping
*
* @return string
*/
public function getDescriptionUnescaped() {
return $this->description;
}
/**
* Get the language of this item
*
* @return string
*/
public function getLanguage() {
$languageCode = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::LanguageCode );
return LanguageCode::bcp47( $languageCode );
}
/**
* Get the date of this item
*
* @return string
*/
public function getDate() {
return $this->date;
}
/**
* Get the author of this item; already xml-encoded
*
* @return string
*/
public function getAuthor() {
return $this->xmlEncode( $this->author );
}
/**
* Get the author of this item without any escaping
*
* @return string
*/
public function getAuthorUnescaped() {
return $this->author;
}
/**
* Get the comment of this item; already xml-encoded
*
* @return string
*/
public function getComments() {
return $this->xmlEncode( $this->comments );
}
/**
* Get the comment of this item without any escaping
*
* @return string
*/
public function getCommentsUnescaped() {
return $this->comments;
}
/**
* Quickie hack... strip out wikilinks to more legible form from the comment.
*
* @param string $text Wikitext
*
* @return string
*/
public static function stripComment( $text ) {
return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
}
}
/** @deprecated class alias since 1.40 */
class_alias( FeedItem::class, 'FeedItem' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 13:32 (1 d, 21 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b6/58/c07f13a650913f32791488c5c7bd
Default Alt Text
FeedItem.php (5 KB)

Event Timeline