MediaWiki  master
SpecialNewpages.php
Go to the documentation of this file.
1 <?php
33  protected $opts;
34  protected $customFilters;
35 
36  protected $showNavigation = false;
37 
38  public function __construct() {
39  parent::__construct( 'Newpages' );
40  }
41 
45  protected function setup( $par ) {
46  $opts = new FormOptions();
47  $this->opts = $opts; // bind
48  $opts->add( 'hideliu', false );
49  $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
50  $opts->add( 'hidebots', false );
51  $opts->add( 'hideredirs', true );
52  $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
53  $opts->add( 'offset', '' );
54  $opts->add( 'namespace', '0' );
55  $opts->add( 'username', '' );
56  $opts->add( 'feed', '' );
57  $opts->add( 'tagfilter', '' );
58  $opts->add( 'invert', false );
59  $opts->add( 'associated', false );
60  $opts->add( 'size-mode', 'max' );
61  $opts->add( 'size', 0 );
62 
63  $this->customFilters = [];
64  Hooks::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters ] );
65  foreach ( $this->customFilters as $key => $params ) {
66  $opts->add( $key, $params['default'] );
67  }
68 
70  if ( $par ) {
71  $this->parseParams( $par );
72  }
73 
74  $opts->validateIntBounds( 'limit', 0, 5000 );
75  }
76 
80  protected function parseParams( $par ) {
81  $bits = preg_split( '/\s*,\s*/', trim( $par ) );
82  foreach ( $bits as $bit ) {
83  if ( $bit === 'shownav' ) {
84  $this->showNavigation = true;
85  }
86  if ( $bit === 'hideliu' ) {
87  $this->opts->setValue( 'hideliu', true );
88  }
89  if ( $bit === 'hidepatrolled' ) {
90  $this->opts->setValue( 'hidepatrolled', true );
91  }
92  if ( $bit === 'hidebots' ) {
93  $this->opts->setValue( 'hidebots', true );
94  }
95  if ( $bit === 'showredirs' ) {
96  $this->opts->setValue( 'hideredirs', false );
97  }
98  if ( is_numeric( $bit ) ) {
99  $this->opts->setValue( 'limit', intval( $bit ) );
100  }
101 
102  $m = [];
103  if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
104  $this->opts->setValue( 'limit', intval( $m[1] ) );
105  }
106  // PG offsets not just digits!
107  if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
108  $this->opts->setValue( 'offset', intval( $m[1] ) );
109  }
110  if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
111  $this->opts->setValue( 'username', $m[1] );
112  }
113  if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
114  $ns = $this->getLanguage()->getNsIndex( $m[1] );
115  if ( $ns !== false ) {
116  $this->opts->setValue( 'namespace', $ns );
117  }
118  }
119  }
120  }
121 
127  public function execute( $par ) {
128  $out = $this->getOutput();
129 
130  $this->setHeaders();
131  $this->outputHeader();
132 
133  $this->showNavigation = !$this->including(); // Maybe changed in setup
134  $this->setup( $par );
135 
136  $this->addHelpLink( 'Help:New pages' );
137 
138  if ( !$this->including() ) {
139  // Settings
140  $this->form();
141 
142  $feedType = $this->opts->getValue( 'feed' );
143  if ( $feedType ) {
144  $this->feed( $feedType );
145 
146  return;
147  }
148 
149  $allValues = $this->opts->getAllValues();
150  unset( $allValues['feed'] );
151  $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
152  }
153 
154  $pager = new NewPagesPager( $this, $this->opts );
155  $pager->mLimit = $this->opts->getValue( 'limit' );
156  $pager->mOffset = $this->opts->getValue( 'offset' );
157 
158  if ( $pager->getNumRows() ) {
159  $navigation = '';
160  if ( $this->showNavigation ) {
161  $navigation = $pager->getNavigationBar();
162  }
163  $out->addHTML( $navigation . $pager->getBody() . $navigation );
164  // Add styles for change tags
165  $out->addModuleStyles( 'mediawiki.interface.helpers.styles' );
166  } else {
167  $out->addWikiMsg( 'specialpage-empty' );
168  }
169  }
170 
171  protected function filterLinks() {
172  // show/hide links
173  $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
174 
175  // Option value -> message mapping
176  $filters = [
177  'hideliu' => 'rcshowhideliu',
178  'hidepatrolled' => 'rcshowhidepatr',
179  'hidebots' => 'rcshowhidebots',
180  'hideredirs' => 'whatlinkshere-hideredirs'
181  ];
182  foreach ( $this->customFilters as $key => $params ) {
183  $filters[$key] = $params['msg'];
184  }
185 
186  // Disable some if needed
187  if ( !User::groupHasPermission( '*', 'createpage' ) ) {
188  unset( $filters['hideliu'] );
189  }
190  if ( !$this->getUser()->useNPPatrol() ) {
191  unset( $filters['hidepatrolled'] );
192  }
193 
194  $links = [];
195  $changed = $this->opts->getChangedValues();
196  unset( $changed['offset'] ); // Reset offset if query type changes
197 
198  // wfArrayToCgi(), called from LinkRenderer/Title, will not output null and false values
199  // to the URL, which would omit some options (T158504). Fix it by explicitly setting them
200  // to 0 or 1.
201  // Also do this only for boolean options, not eg. namespace or tagfilter
202  foreach ( $changed as $key => $value ) {
203  if ( array_key_exists( $key, $filters ) ) {
204  $changed[$key] = $changed[$key] ? '1' : '0';
205  }
206  }
207 
208  $self = $this->getPageTitle();
209  $linkRenderer = $this->getLinkRenderer();
210  foreach ( $filters as $key => $msg ) {
211  $onoff = 1 - $this->opts->getValue( $key );
212  $link = $linkRenderer->makeLink(
213  $self,
214  new HtmlArmor( $showhide[$onoff] ),
215  [],
216  [ $key => $onoff ] + $changed
217  );
218  $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
219  }
220 
221  return $this->getLanguage()->pipeList( $links );
222  }
223 
224  protected function form() {
225  $out = $this->getOutput();
226 
227  // Consume values
228  $this->opts->consumeValue( 'offset' ); // don't carry offset, DWIW
229  $namespace = $this->opts->consumeValue( 'namespace' );
230  $username = $this->opts->consumeValue( 'username' );
231  $tagFilterVal = $this->opts->consumeValue( 'tagfilter' );
232  $nsinvert = $this->opts->consumeValue( 'invert' );
233  $nsassociated = $this->opts->consumeValue( 'associated' );
234 
235  $size = $this->opts->consumeValue( 'size' );
236  $max = $this->opts->consumeValue( 'size-mode' ) === 'max';
237 
238  // Check username input validity
240  $userText = $ut ? $ut->getText() : '';
241 
242  $formDescriptor = [
243  'namespace' => [
244  'type' => 'namespaceselect',
245  'name' => 'namespace',
246  'label-message' => 'namespace',
247  'default' => $namespace,
248  ],
249  'nsinvert' => [
250  'type' => 'check',
251  'name' => 'invert',
252  'label-message' => 'invert',
253  'default' => $nsinvert,
254  'tooltip' => 'invert',
255  ],
256  'nsassociated' => [
257  'type' => 'check',
258  'name' => 'associated',
259  'label-message' => 'namespace_association',
260  'default' => $nsassociated,
261  'tooltip' => 'namespace_association',
262  ],
263  'tagFilter' => [
264  'type' => 'tagfilter',
265  'name' => 'tagfilter',
266  'label-raw' => $this->msg( 'tag-filter' )->parse(),
267  'default' => $tagFilterVal,
268  ],
269  'username' => [
270  'type' => 'user',
271  'name' => 'username',
272  'label-message' => 'newpages-username',
273  'default' => $userText,
274  'id' => 'mw-np-username',
275  'size' => 30,
276  ],
277  'size' => [
278  'type' => 'sizefilter',
279  'name' => 'size',
280  'default' => -$max * $size,
281  ],
282  ];
283 
284  $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
285 
286  // Store query values in hidden fields so that form submission doesn't lose them
287  foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
288  $htmlForm->addHiddenField( $key, $value );
289  }
290 
291  $htmlForm
292  ->setMethod( 'get' )
293  ->setFormIdentifier( 'newpagesform' )
294  // The form should be visible on each request (inclusive requests with submitted forms), so
295  // return always false here.
296  ->setSubmitCallback(
297  function () {
298  return false;
299  }
300  )
301  ->setSubmitText( $this->msg( 'newpages-submit' )->text() )
302  ->setWrapperLegend( $this->msg( 'newpages' )->text() )
303  ->addFooterText( Html::rawElement(
304  'div',
305  null,
306  $this->filterLinks()
307  ) )
308  ->show();
309  $out->addModuleStyles( 'mediawiki.special' );
310  }
311 
318  return new Revision( [
319  'comment' => CommentStore::getStore()->getComment( 'rc_comment', $result )->text,
320  'deleted' => $result->rc_deleted,
321  'user_text' => $result->rc_user_text,
322  'user' => $result->rc_user,
323  'actor' => $result->rc_actor,
324  ], 0, $title );
325  }
326 
334  public function formatRow( $result ) {
336 
337  // Revision deletion works on revisions,
338  // so cast our recent change row to a revision row.
340 
341  $classes = [];
342  $attribs = [ 'data-mw-revid' => $result->rev_id ];
343 
344  $lang = $this->getLanguage();
345  $dm = $lang->getDirMark();
346 
347  $spanTime = Html::element( 'span', [ 'class' => 'mw-newpages-time' ],
348  $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
349  );
350  $linkRenderer = $this->getLinkRenderer();
351  $time = $linkRenderer->makeKnownLink(
352  $title,
353  new HtmlArmor( $spanTime ),
354  [],
355  [ 'oldid' => $result->rc_this_oldid ]
356  );
357 
358  $query = $title->isRedirect() ? [ 'redirect' => 'no' ] : [];
359 
360  $plink = $linkRenderer->makeKnownLink(
361  $title,
362  null,
363  [ 'class' => 'mw-newpages-pagename' ],
364  $query
365  );
366  $histLink = $linkRenderer->makeKnownLink(
367  $title,
368  $this->msg( 'hist' )->text(),
369  [],
370  [ 'action' => 'history' ]
371  );
372  $hist = Html::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
373  $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
374 
375  $length = Html::rawElement(
376  'span',
377  [ 'class' => 'mw-newpages-length' ],
378  $this->msg( 'brackets' )->rawParams(
379  $this->msg( 'nbytes' )->numParams( $result->length )->escaped()
380  )->escaped()
381  );
382 
383  $ulink = Linker::revUserTools( $rev );
384  $comment = Linker::revComment( $rev );
385 
386  if ( $this->patrollable( $result ) ) {
387  $classes[] = 'not-patrolled';
388  }
389 
390  # Add a class for zero byte pages
391  if ( $result->length == 0 ) {
392  $classes[] = 'mw-newpages-zero-byte-page';
393  }
394 
395  # Tags, if any.
396  if ( isset( $result->ts_tags ) ) {
397  list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
398  $result->ts_tags,
399  'newpages',
400  $this->getContext()
401  );
402  $classes = array_merge( $classes, $newClasses );
403  } else {
404  $tagDisplay = '';
405  }
406 
407  # Display the old title if the namespace/title has been changed
408  $oldTitleText = '';
409  $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
410 
411  if ( !$title->equals( $oldTitle ) ) {
412  $oldTitleText = $oldTitle->getPrefixedText();
413  $oldTitleText = Html::rawElement(
414  'span',
415  [ 'class' => 'mw-newpages-oldtitle' ],
416  $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
417  );
418  }
419 
420  $ret = "{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} "
421  . "{$tagDisplay} {$oldTitleText}";
422 
423  // Let extensions add data
424  Hooks::run( 'NewPagesLineEnding', [ $this, &$ret, $result, &$classes, &$attribs ] );
425  $attribs = array_filter( $attribs,
426  [ Sanitizer::class, 'isReservedDataAttribute' ],
427  ARRAY_FILTER_USE_KEY
428  );
429 
430  if ( count( $classes ) ) {
431  $attribs['class'] = implode( ' ', $classes );
432  }
433 
434  return Html::rawElement( 'li', $attribs, $ret ) . "\n";
435  }
436 
443  protected function patrollable( $result ) {
444  return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
445  }
446 
452  protected function feed( $type ) {
453  if ( !$this->getConfig()->get( 'Feed' ) ) {
454  $this->getOutput()->addWikiMsg( 'feed-unavailable' );
455 
456  return;
457  }
458 
459  $feedClasses = $this->getConfig()->get( 'FeedClasses' );
460  if ( !isset( $feedClasses[$type] ) ) {
461  $this->getOutput()->addWikiMsg( 'feed-invalid' );
462 
463  return;
464  }
465 
466  $feed = new $feedClasses[$type](
467  $this->feedTitle(),
468  $this->msg( 'tagline' )->text(),
469  $this->getPageTitle()->getFullURL()
470  );
471 
472  $pager = new NewPagesPager( $this, $this->opts );
473  $limit = $this->opts->getValue( 'limit' );
474  $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
475 
476  $feed->outHeader();
477  if ( $pager->getNumRows() > 0 ) {
478  foreach ( $pager->mResult as $row ) {
479  $feed->outItem( $this->feedItem( $row ) );
480  }
481  }
482  $feed->outFooter();
483  }
484 
485  protected function feedTitle() {
486  $desc = $this->getDescription();
487  $code = $this->getConfig()->get( 'LanguageCode' );
488  $sitename = $this->getConfig()->get( 'Sitename' );
489 
490  return "$sitename - $desc [$code]";
491  }
492 
493  protected function feedItem( $row ) {
494  $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
495  if ( $title ) {
496  $date = $row->rc_timestamp;
497  $comments = $title->getTalkPage()->getFullURL();
498 
499  return new FeedItem(
500  $title->getPrefixedText(),
501  $this->feedItemDesc( $row ),
502  $title->getFullURL(),
503  $date,
504  $this->feedItemAuthor( $row ),
505  $comments
506  );
507  } else {
508  return null;
509  }
510  }
511 
512  protected function feedItemAuthor( $row ) {
513  return $row->rc_user_text ?? '';
514  }
515 
516  protected function feedItemDesc( $row ) {
517  $revision = Revision::newFromId( $row->rev_id );
518  if ( !$revision ) {
519  return '';
520  }
521 
522  $content = $revision->getContent();
523  if ( $content === null ) {
524  return '';
525  }
526 
527  // XXX: include content model/type in feed item?
528  return '<p>' . htmlspecialchars( $revision->getUserText() ) .
529  $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
530  htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
531  "</p>\n<hr />\n<div>" .
532  nl2br( htmlspecialchars( $content->serialize() ) ) . "</div>";
533  }
534 
535  protected function getGroupName() {
536  return 'changes';
537  }
538 
539  protected function getCacheTTL() {
540  return 60 * 5;
541  }
542 }
static stripComment( $text)
Quickie hack...
Definition: FeedItem.php:218
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
revisionFromRcResult(stdClass $result, Title $title)
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1529
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
getContext()
Gets the context this SpecialPage is executed in.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1972
including( $x=null)
Whether the special page is being evaluated via transclusion.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2051
if(!isset( $args[0])) $lang
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
A special page that list newly created pages.
$value
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
getOutput()
Get the OutputPage being used for this instance.
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:522
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1781
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
add( $name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:83
feed( $type)
Output a subscription feed listing recent edits to this page.
validateIntBounds( $name, $min, $max)
patrollable( $result)
Should a specific result row provide "patrollable" links?
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
fetchValuesFromRequest(WebRequest $r, $optionKeys=null)
Fetch values for all options (or selected options) from the given WebRequest, making them available f...
FormOptions $opts
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3039
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:767
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
Shortcut to construct an includable special page.
$self
$params
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1972
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1748
A base class for outputting syndication feeds (e.g.
Definition: FeedItem.php:33
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:767
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4831
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:620
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:767
static getStore()
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
versus $oldTitle
Definition: globals.txt:16
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
execute( $par)
Show a form for filtering namespace and username.
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:94
static revComment(Revision $rev, $local=false, $isPublic=false, $useParentheses=true)
Wrap and format the given revision&#39;s comment block, if the current user is allowed to view it...
Definition: Linker.php:1572
getRequest()
Get the WebRequest being used for this instance.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:118
$content
Definition: pageupdater.txt:72
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
formatRow( $result)
Format a row, providing the timestamp, links to the page/history, size, user links, and a comment.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static revUserTools( $rev, $isPublic=false, $useParentheses=true)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1119
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67