mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-12-24 13:55:04 +00:00
e72f58ca78
Inspired by this Wikitech-l discussion: https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/thread/NWXPNHRNLEVXHSWX33H473OAWQP6CDOA/ To keep this simple for now, I am only removing redundant PHPDoc comments on constructors, and only when all the documentation for parameters completely duplicates type hints. More could be done, but that can happen later when we have better tooling. Redundant comments on constructors that take a dozen services are by far the most annoying for me and I want them gone now. Change-Id: I86cbf7d6e48035cfa06f780c8fb1b02e68709a0c
122 lines
2.7 KiB
PHP
122 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools;
|
|
|
|
use FormSpecialPage;
|
|
use Html;
|
|
use HTMLForm;
|
|
|
|
class SpecialFindComment extends FormSpecialPage {
|
|
|
|
private ThreadItemStore $threadItemStore;
|
|
private ThreadItemFormatter $threadItemFormatter;
|
|
|
|
public function __construct(
|
|
ThreadItemStore $threadItemStore,
|
|
ThreadItemFormatter $threadItemFormatter
|
|
) {
|
|
parent::__construct( 'FindComment' );
|
|
$this->threadItemStore = $threadItemStore;
|
|
$this->threadItemFormatter = $threadItemFormatter;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function getFormFields() {
|
|
return [
|
|
'idorname' => [
|
|
'label-message' => 'discussiontools-findcomment-label-idorname',
|
|
'name' => 'idorname',
|
|
'type' => 'text',
|
|
'default' => $this->par,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function getDisplayFormat() {
|
|
return 'ooui';
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function alterForm( HTMLForm $form ) {
|
|
$form->setMethod( 'GET' );
|
|
$form->setWrapperLegend( true );
|
|
$form->setSubmitTextMsg( 'discussiontools-findcomment-label-search' );
|
|
// Remove subpage when submitting
|
|
$form->setTitle( $this->getPageTitle() );
|
|
}
|
|
|
|
private $idOrName;
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function onSubmit( array $data ) {
|
|
$this->idOrName = $data['idorname'];
|
|
// Always display the form again
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function execute( $par ) {
|
|
parent::execute( $par );
|
|
|
|
$out = $this->getOutput();
|
|
$results = false;
|
|
|
|
if ( $this->idOrName ) {
|
|
$byId = $this->threadItemStore->findNewestRevisionsById( $this->idOrName );
|
|
if ( $byId ) {
|
|
$this->displayItems( $byId, 'discussiontools-findcomment-results-id' );
|
|
$results = true;
|
|
}
|
|
|
|
$byName = $this->threadItemStore->findNewestRevisionsByName( $this->idOrName );
|
|
if ( $byName ) {
|
|
$this->displayItems( $byName, 'discussiontools-findcomment-results-name' );
|
|
$results = true;
|
|
}
|
|
}
|
|
|
|
if ( $results ) {
|
|
$out->addHTML(
|
|
$this->msg( 'discussiontools-findcomment-gotocomment', $this->idOrName )->parseAsBlock() );
|
|
} elseif ( $this->idOrName ) {
|
|
$out->addHTML(
|
|
$this->msg( 'discussiontools-findcomment-noresults' )->parseAsBlock() );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $threadItems
|
|
* @param string $msgKey
|
|
*/
|
|
private function displayItems( array $threadItems, string $msgKey ) {
|
|
$out = $this->getOutput();
|
|
|
|
$list = [];
|
|
foreach ( $threadItems as $item ) {
|
|
$line = $this->threadItemFormatter->formatLine( $item, $this );
|
|
$list[] = Html::rawElement( 'li', [], $line );
|
|
}
|
|
|
|
$out->addHTML( $this->msg( $msgKey, count( $list ) )->parseAsBlock() );
|
|
$out->addHTML( Html::rawElement( 'ul', [], implode( '', $list ) ) );
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getDescription() {
|
|
return $this->msg( 'discussiontools-findcomment-title' )->text();
|
|
}
|
|
}
|