1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?php
/**
* Variant of QueryPage which formats the result as a simple link to the page.
*
* 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
* @ingroup SpecialPage
*/
namespace MediaWiki\SpecialPage;
use HtmlArmor;
use MediaWiki\Html\Html;
use MediaWiki\Language\ILanguageConverter;
use MediaWiki\Linker\Linker;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use Skin;
use stdClass;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IResultWrapper;
/**
* Variant of QueryPage which formats the result as a simple link to the page
*
* @stable to extend
* @ingroup SpecialPage
*/
abstract class PageQueryPage extends QueryPage {
/** @var ILanguageConverter|null */
private $languageConverter = null;
/**
* Run a LinkBatch to pre-cache LinkCache information,
* like page existence and information for stub color and redirect hints.
* This should be done for live data and cached data.
*
* @stable to override
*
* @param IDatabase $db
* @param IResultWrapper $res
*/
public function preprocessResults( $db, $res ) {
$this->executeLBFromResultWrapper( $res );
}
/**
* @since 1.36
* @param ILanguageConverter $languageConverter
*/
final protected function setLanguageConverter( ILanguageConverter $languageConverter ) {
$this->languageConverter = $languageConverter;
}
/**
* @note Call self::setLanguageConverter in your constructor when overriding
*
* @since 1.36
* @return ILanguageConverter
*/
final protected function getLanguageConverter(): ILanguageConverter {
if ( $this->languageConverter === null ) {
// Fallback if not provided
// TODO Change to wfWarn in a future release
$this->languageConverter = MediaWikiServices::getInstance()->getLanguageConverterFactory()
->getLanguageConverter( $this->getContentLanguage() );
}
return $this->languageConverter;
}
/**
* Format the result as a simple link to the page
*
* @stable to override
*
* @param Skin $skin
* @param stdClass $row Result row
* @return string
*/
public function formatResult( $skin, $row ) {
$title = Title::makeTitleSafe( $row->namespace, $row->title );
if ( $title instanceof Title ) {
$text = $this->getLanguageConverter()->convertHtml( $title->getPrefixedText() );
return $this->getLinkRenderer()->makeLink( $title, new HtmlArmor( $text ) );
} else {
return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
Linker::getInvalidTitleDescription( $this->getContext(), $row->namespace, $row->title ) );
}
}
}
/** @deprecated class alias since 1.41 */
class_alias( PageQueryPage::class, 'PageQueryPage' );
|
