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
124 lines
3 KiB
PHP
124 lines
3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\CommentFormatter;
|
|
|
|
use ArrayIterator;
|
|
use CommentStore;
|
|
use IteratorIterator;
|
|
use TitleValue;
|
|
use Traversable;
|
|
|
|
/**
|
|
* An adaptor which converts a row iterator into a CommentItem iterator for
|
|
* batch formatting.
|
|
*
|
|
* Fluent-style mutators are provided to configure how comment text is extracted
|
|
* from rows.
|
|
*
|
|
* Using an iterator for this configuration, instead of putting the
|
|
* options in CommentBatch, allows CommentBatch to be a simple single
|
|
* class without a CommentStore dependency.
|
|
*
|
|
* @since 1.38
|
|
*/
|
|
class RowCommentIterator extends IteratorIterator {
|
|
/** @var CommentStore */
|
|
private $commentStore;
|
|
/** @var string|null */
|
|
private $commentKey;
|
|
/** @var string|null */
|
|
private $namespaceField;
|
|
/** @var string|null */
|
|
private $titleField;
|
|
/** @var string|null */
|
|
private $indexField;
|
|
|
|
/**
|
|
* @internal Use RowCommentFormatter::rows()
|
|
* @param CommentStore $commentStore
|
|
* @param Traversable|array $rows
|
|
*/
|
|
public function __construct( CommentStore $commentStore, $rows ) {
|
|
if ( is_array( $rows ) ) {
|
|
parent::__construct( new ArrayIterator( $rows ) );
|
|
} else {
|
|
parent::__construct( $rows );
|
|
}
|
|
|
|
$this->commentStore = $commentStore;
|
|
}
|
|
|
|
/**
|
|
* Set what CommentStore calls the key -- typically a legacy field name
|
|
* which once held a comment. This must be called before attempting
|
|
* iteration.
|
|
*
|
|
* @param string $key
|
|
* @return $this
|
|
*/
|
|
public function commentKey( $key ) {
|
|
$this->commentKey = $key;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the namespace field. If this is not called, the item will not have
|
|
* a self-link target, although it may be provided by the batch.
|
|
*
|
|
* @param string $field
|
|
* @return $this
|
|
*/
|
|
public function namespaceField( $field ) {
|
|
$this->namespaceField = $field;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the title field. If this is not called, the item will not have
|
|
* a self-link target, although it may be provided by the batch.
|
|
*
|
|
* @param string $field
|
|
* @return $this
|
|
*/
|
|
public function titleField( $field ) {
|
|
$this->titleField = $field;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the index field. Values from this field will appear as array keys
|
|
* in the final formatted comment array. If unset, the array will be
|
|
* numerically indexed.
|
|
*
|
|
* @param string $field
|
|
* @return $this
|
|
*/
|
|
public function indexField( $field ) {
|
|
$this->indexField = $field;
|
|
return $this;
|
|
}
|
|
|
|
public function key() {
|
|
if ( $this->indexField ) {
|
|
return parent::current()->{$this->indexField};
|
|
} else {
|
|
return parent::key();
|
|
}
|
|
}
|
|
|
|
public function current() {
|
|
if ( $this->commentKey === null ) {
|
|
throw new \RuntimeException( __METHOD__ . ': commentKey must be specified' );
|
|
}
|
|
$row = parent::current();
|
|
$comment = $this->commentStore->getComment( $this->commentKey, $row );
|
|
$item = new CommentItem( $comment->text );
|
|
if ( $this->namespaceField && $this->titleField ) {
|
|
$item->selfLinkTarget( new TitleValue(
|
|
(int)$row->{$this->namespaceField},
|
|
$row->{$this->titleField}
|
|
) );
|
|
}
|
|
return $item;
|
|
}
|
|
}
|