Movatterモバイル変換

SpecialPrefixIndex.php

Go to the documentation of this file.

1<?php

7namespaceMediaWiki\Specials;

9use MediaWiki\Cache\LinkCache;

10useMediaWiki\Html\Html;

11useMediaWiki\HTMLForm\Field\HTMLCheckField;

12useMediaWiki\HTMLForm\HTMLForm;

13useMediaWiki\Title\Title;

14useWikimedia\Rdbms\IConnectionProvider;

15useWikimedia\Rdbms\IExpression;

16useWikimedia\Rdbms\LikeValue;

24classSpecialPrefixIndexextendsSpecialAllPages {

31protected$stripPrefix =false;

34protected$hideRedirects =false;

36// Inherit $maxPerPage

38// phpcs:ignore MediaWiki.Commenting.PropertyDocumentation.WrongStyle

39privateIConnectionProvider $dbProvider;

40private LinkCache $linkCache;

42publicfunction__construct(

43IConnectionProvider $dbProvider,

44 LinkCache $linkCache

45 ) {

46 parent::__construct( $dbProvider );

47 $this->mName ='Prefixindex';

48 $this->dbProvider = $dbProvider;

49 $this->linkCache = $linkCache;

50 }

56publicfunctionexecute( $par ) {

57 $this->setHeaders();

58 $this->outputHeader();

60 $out = $this->getOutput();

61 $out->addModuleStyles('mediawiki.special' );

63 # GET values

64 $request = $this->getRequest();

65 $from = $request->getVal('from','' );

66 $prefix = $request->getVal('prefix','' );

67 $ns = $request->getIntOrNull('namespace' );

68 $namespace = (int)$ns;// if no namespace given, use 0 (NS_MAIN).

69 $this->hideRedirects = $request->getBool('hideredirects', $this->hideRedirects );

70 $this->stripPrefix = $request->getBool('stripprefix', $this->stripPrefix );

72 $namespaces = $this->getContentLanguage()->getNamespaces();

73 $out->setPageTitleMsg(

74 ( $namespace > 0 && array_key_exists( $namespace, $namespaces ) )

75 ? $this->msg('prefixindex-namespace' )->plaintextParams(

76 str_replace('_',' ', $namespaces[$namespace] )

77 )

78 : $this->msg('prefixindex' )

79 );

81 $showme ='';

82if ( $par !==null ) {

83 $showme = $par;

84 } elseif ( $prefix !='' ) {

85 $showme = $prefix;

86 } elseif ( $from !='' && $ns ===null ) {

87// For back-compat with Special:Allpages

88// Don't do this if namespace is passed, so paging works when doing NS views.

89 $showme = $from;

90 }

92// T29864: if transcluded, show all pages instead of the form.

93if ( $this->including() || $showme !='' || $ns !==null ) {

94 $this->showPrefixChunk( $namespace, $showme, $from );

95 }else {

96 $out->addHTML( $this->namespacePrefixForm( $namespace,'' )->getHTML(false ) );

97 }

98 }

106protectedfunctionnamespacePrefixForm( $namespace =NS_MAIN, $from ='' ):HTMLForm {

107 $formDescriptor = [

108'prefix' => [

109'label-message' =>'allpagesprefix',

110'name' =>'prefix',

111'id' =>'nsfrom',

112'type' =>'text',

113'size' =>'30',

114'default' => str_replace('_',' ', $from ),

115 ],

116'namespace' => [

117'type' =>'namespaceselect',

118'name' =>'namespace',

119'id' =>'namespace',

120'label-message' =>'namespace',

121'all' => null,

122'default' => $namespace,

123 ],

124'hidedirects' => [

125'class' =>HTMLCheckField::class,

126'name' =>'hideredirects',

127'label-message' =>'allpages-hide-redirects',

128 ],

129'stripprefix' => [

130'class' =>HTMLCheckField::class,

131'name' =>'stripprefix',

132'label-message' =>'prefixindex-strip',

133 ],

134 ];

135

136 $this->getHookRunner()->onSpecialPrefixIndexGetFormFilters( $this->getContext(), $formDescriptor );

137

138 $htmlForm = HTMLForm::factory('ooui', $formDescriptor, $this->getContext() )

139 ->setMethod('get' )

140 ->setTitle( $this->getPageTitle() )// Remove subpage

141 ->setWrapperLegendMsg('prefixindex' )

142 ->setSubmitTextMsg('prefixindex-submit' );

143

144return $htmlForm->prepareForm();

145 }

146

152protectedfunctionshowPrefixChunk( $namespace, $prefix, $from =null ) {

153 $from ??= $prefix;

154

155 $fromList = $this->getNamespaceKeyAndText( $namespace, $from );

156 $prefixList = $this->getNamespaceKeyAndText( $namespace, $prefix );

157 $namespaces = $this->getContentLanguage()->getNamespaces();

158 $res =null;

159 $n = 0;

160 $nextRow =null;

161 $preparedHtmlForm = $this->namespacePrefixForm( $namespace, $prefix );

162

163if ( !$prefixList || !$fromList ) {

164 $out = $this->msg('allpagesbadtitle' )->parseAsBlock();

165 } elseif ( !array_key_exists( $namespace, $namespaces ) ) {

166// Show errormessage and reset to NS_MAIN

167 $out = $this->msg('allpages-bad-ns', $namespace )->parse();

168 $namespace =NS_MAIN;

169 }else {

170 [ $namespace, $prefixKey, $prefix ] = $prefixList;

171 [/* $fromNS */, $fromKey, ] = $fromList;

172

173 # ## @todo FIXME: Should complain if $fromNs != $namespace

174

175 $dbr = $this->dbProvider->getReplicaDatabase();

176 $queryBuiler = $dbr->newSelectQueryBuilder()

177 ->select( LinkCache::getSelectFields() )

178 ->from('page' )

179 ->where( [

180'page_namespace' => $namespace,

181 $dbr->expr(

182'page_title',

183 IExpression::LIKE,

184newLikeValue( $prefixKey, $dbr->anyString() )

185 ),

186 $dbr->expr('page_title','>=', $fromKey ),

187 ] )

188 ->orderBy('page_title' )

189 ->limit( $this->maxPerPage + 1 )

190 ->useIndex('page_name_title' );

191

192if ( $this->hideRedirects ) {

193 $queryBuiler->andWhere( ['page_is_redirect' => 0 ] );

194 }

195

196 $this->getHookRunner()->onSpecialPrefixIndexQuery( $preparedHtmlForm->mFieldData, $queryBuiler );

197

198 $res = $queryBuiler->caller( __METHOD__ )->fetchResultSet();

199

200// @todo FIXME: Side link to previous

201

202if ( $res->numRows() > 0 ) {

203 $out = Html::openElement('ul', ['class' =>'mw-prefixindex-list' ] );

204

205 $prefixLength = strlen( $prefix );

206foreach ( $res as $row ) {

207if ( $n >= $this->maxPerPage ) {

208 $nextRow = $row;

209break;

210 }

211 $title = Title::newFromRow( $row );

212// Make sure it gets into LinkCache

213 $this->linkCache->addGoodLinkObjFromRow( $title, $row );

214 $displayed = $title->getText();

215// Try not to generate unclickable links

216if ( $this->stripPrefix && $prefixLength !== strlen( $displayed ) ) {

217 $displayed = substr( $displayed, $prefixLength );

218 }

219 $link = ( $title->isRedirect() ?'<div class="allpagesredirect">' :'' ) .

220 $this->getLinkRenderer()->makeKnownLink(

221 $title,

222 $displayed

223 ) .

224 ( $title->isRedirect() ?'</div>' :'' );

225

226 $out .="<li>$link</li>\n";

227 $n++;

228

229 }

230 $out .= Html::closeElement('ul' );

231

232if ( $res->numRows() > 2 ) {

233// Only apply CSS column styles if there are more than 2 entries.

234// Otherwise, rendering is broken as "mw-prefixindex-body"'s CSS column count is 3.

235 $out = Html::rawElement('div', ['class' =>'mw-prefixindex-body' ], $out );

236 }

237 }else {

238 $out ='';

239 }

240 }

241

242 $output = $this->getOutput();

243

244if ( $this->including() ) {

245// We don't show the nav-links and the form when included in other

246// pages, so let's just finish here.

247 $output->addHTML( $out );

248return;

249 }

250

251 $topOut = $preparedHtmlForm->getHTML(false );

252

253if ( $res && ( $n == $this->maxPerPage ) && $nextRow ) {

254 $query = [

255'from' => $nextRow->page_title,

256'prefix' => $prefix,

257'hideredirects' => $this->hideRedirects,

258'stripprefix' => $this->stripPrefix,

259 ];

260

261if ( $namespace || $prefix =='' ) {

262// Keep the namespace even if it's 0 for empty prefixes.

263// This tells us we're not just a holdover from old links.

264 $query['namespace'] = $namespace;

265 }

266

267 $nextLink = $this->getLinkRenderer()->makeKnownLink(

268 $this->getPageTitle(),

269 $this->msg('nextpage', str_replace('_',' ', $nextRow->page_title ) )->text(),

270 [],

271 $query

272 );

273

274// Link shown at the top of the page below the form

275 $topOut .= Html::rawElement('div',

276 ['class' =>'mw-prefixindex-nav' ],

277 $nextLink

278 );

279

280// Link shown at the footer

281 $out .="\n" .Html::element('hr' ) .

282 Html::rawElement(

283'div',

284 ['class' =>'mw-prefixindex-nav' ],

285 $nextLink

286 );

287

288 }

289

290 $output->addHTML( $topOut . $out );

291 }

292

294protectedfunctiongetGroupName() {

295return'pages';

296 }

297}

298

303class_alias( SpecialPrefixIndex::class,'SpecialPrefixindex' );

NS_MAIN

const NS_MAIN

DefinitionDefines.php:51

MediaWiki\HTMLForm\Field\HTMLCheckField

A checkbox field.

DefinitionHTMLCheckField.php:17

MediaWiki\HTMLForm\HTMLForm

Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...

DefinitionHTMLForm.php:195

MediaWiki\HTMLForm\HTMLForm\setMethod

setMethod( $method='post')

Set the method used to submit the form.

DefinitionHTMLForm.php:1801

MediaWiki\Html\Html

This class is a collection of static functions that serve two purposes:

DefinitionHtml.php:43

MediaWiki\SpecialPage\SpecialPage\setHeaders

setHeaders()

Sets headers - this should be called from the execute() method of all derived classes!

DefinitionSpecialPage.php:685

MediaWiki\SpecialPage\SpecialPage\getPageTitle

getPageTitle( $subpage=false)

Get a self-referential title object.

DefinitionSpecialPage.php:828

MediaWiki\SpecialPage\SpecialPage\getContext

getContext()

Gets the context this SpecialPage is executed in.

DefinitionSpecialPage.php:848

MediaWiki\SpecialPage\SpecialPage\getRequest

getRequest()

Get the WebRequest being used for this instance.

DefinitionSpecialPage.php:864

MediaWiki\SpecialPage\SpecialPage\msg

msg( $key,... $params)

Wrapper around wfMessage that sets the current context.

DefinitionSpecialPage.php:985

MediaWiki\SpecialPage\SpecialPage\getOutput

getOutput()

Get the OutputPage being used for this instance.

DefinitionSpecialPage.php:874

MediaWiki\SpecialPage\SpecialPage\getContentLanguage

getContentLanguage()

Shortcut to get content language.

DefinitionSpecialPage.php:924

MediaWiki\SpecialPage\SpecialPage\including

including( $x=null)

Whether the special page is being evaluated via transclusion.

DefinitionSpecialPage.php:272

MediaWiki\SpecialPage\SpecialPage\outputHeader

outputHeader( $summaryMessageKey='')

Outputs a summary message on top of special pages By default the message key is the canonical name of...

DefinitionSpecialPage.php:773

MediaWiki\SpecialPage\SpecialPage\getHookRunner

getHookRunner()

DefinitionSpecialPage.php:1194

MediaWiki\Specials\SpecialAllPages

Implements Special:Allpages.

DefinitionSpecialAllPages.php:28

MediaWiki\Specials\SpecialPrefixIndex

Implements Special:Prefixindex.

DefinitionSpecialPrefixIndex.php:24

MediaWiki\Specials\SpecialPrefixIndex\$hideRedirects

bool $hideRedirects

DefinitionSpecialPrefixIndex.php:34

MediaWiki\Specials\SpecialPrefixIndex\namespacePrefixForm

namespacePrefixForm( $namespace=NS_MAIN, $from='')

Prepared HTMLForm object for the top form.

DefinitionSpecialPrefixIndex.php:106

MediaWiki\Specials\SpecialPrefixIndex\__construct

__construct(IConnectionProvider $dbProvider, LinkCache $linkCache)

DefinitionSpecialPrefixIndex.php:42

MediaWiki\Specials\SpecialPrefixIndex\getGroupName

getGroupName()

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...

DefinitionSpecialPrefixIndex.php:294

MediaWiki\Specials\SpecialPrefixIndex\showPrefixChunk

showPrefixChunk( $namespace, $prefix, $from=null)

DefinitionSpecialPrefixIndex.php:152

MediaWiki\Specials\SpecialPrefixIndex\$stripPrefix

bool $stripPrefix

Whether to remove the searched prefix from the displayed link.

DefinitionSpecialPrefixIndex.php:31

MediaWiki\Specials\SpecialPrefixIndex\execute

execute( $par)

Entry point: initialise variables and call subfunctions.

DefinitionSpecialPrefixIndex.php:56

MediaWiki\Title\Title

Represents a title within MediaWiki.

DefinitionTitle.php:69

Wikimedia\Rdbms\LikeValue

Content of like value.

DefinitionLikeValue.php:14

Wikimedia\Rdbms\IConnectionProvider

Provide primary and replica IDatabase connections.

DefinitionIConnectionProvider.php:21

Wikimedia\Rdbms\IExpression

DefinitionIExpression.php:10

MediaWiki\Html\element

element(SerializerNode $parent, SerializerNode $node, $contents)

DefinitionHtmlHelperTrait.php:38

MediaWiki\Specials