f7f84dddb3
CommentParser: * Move comment formatting backend from Linker to a CommentParser service. Allow link existence and file existence to be batched. * Rename $local to $samePage since I think that is clearer. * Rename $title to $selfLinkTarget since it was unclear what the title was used for. * Rename the "autocomment" concept to "section link" in public interfaces, although the old term remains in CSS classes. * Keep unsafe HTML pass-through in separate "unsafe" methods, for easier static analysis and code review. CommentFormatter: * Add CommentFormatter and RowCommentFormatter services as a usable frontend for comment batches, and to replace the Linker static methods. * Provide fluent and parametric interfaces. Linker: * Remove Linker::makeCommentLink() without deprecation -- nothing calls it and it is obviously an internal helper. * Soft-deprecate Linker methods formatComment(), formatLinksInComment(), commentBlock() and revComment(). Caller migration: * CommentFormatter single: Linker, RollbackAction, ApiComparePages, ApiParse * CommentFormatter parametric batch: ImageHistoryPseudoPager * CommentFormatter fluent batch: ApiQueryFilearchive * RowCommentFormatter sequential: History feed, BlocklistPager, ProtectedPagesPager, ApiQueryProtectedTitles * RowCommentFormatter with index: ChangesFeed, ChangesList, ApiQueryDeletedrevs, ApiQueryLogEvents, ApiQueryRecentChanges * RevisionCommentBatch: HistoryPager, ContribsPager Bug: T285917 Change-Id: Ia3fd50a4a13138ba5003d884962da24746d562d0
82 lines
1.6 KiB
PHP
82 lines
1.6 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\CommentFormatter;
|
|
|
|
use MediaWiki\Linker\LinkTarget;
|
|
|
|
/**
|
|
* An object to represent one of the inputs to a batch formatting operation.
|
|
*
|
|
* @since 1.38
|
|
* @newable
|
|
*/
|
|
class CommentItem {
|
|
/**
|
|
* @var string
|
|
* @internal
|
|
*/
|
|
public $comment;
|
|
|
|
/**
|
|
* @var LinkTarget|null
|
|
* @internal
|
|
*/
|
|
public $selfLinkTarget;
|
|
|
|
/**
|
|
* @var bool|null
|
|
* @internal
|
|
*/
|
|
public $samePage;
|
|
|
|
/**
|
|
* @var string|false|null
|
|
* @internal
|
|
*/
|
|
public $wikiId;
|
|
|
|
/**
|
|
* @param string $comment The comment to format
|
|
*/
|
|
public function __construct( string $comment ) {
|
|
$this->comment = $comment;
|
|
}
|
|
|
|
/**
|
|
* Set the self-link target.
|
|
*
|
|
* @param LinkTarget $selfLinkTarget The title used for fragment-only
|
|
* and section links, formerly $title.
|
|
* @return $this
|
|
*/
|
|
public function selfLinkTarget( LinkTarget $selfLinkTarget ) {
|
|
$this->selfLinkTarget = $selfLinkTarget;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the same-page flag.
|
|
*
|
|
* @param bool $samePage If true, self links are rendered with a fragment-
|
|
* only URL. Formerly $local.
|
|
* @return $this
|
|
*/
|
|
public function samePage( $samePage = true ) {
|
|
$this->samePage = $samePage;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* ID of the wiki to link to (if not the local wiki), as used by WikiMap.
|
|
* This is used to render comments which are loaded from a foreign wiki.
|
|
* This only affects links which are syntactically internal -- it has no
|
|
* effect on interwiki links.
|
|
*
|
|
* @param string|false|null $wikiId
|
|
* @return $this
|
|
*/
|
|
public function wikiId( $wikiId ) {
|
|
$this->wikiId = $wikiId;
|
|
return $this;
|
|
}
|
|
}
|