MediaWiki  1.28.0
LogFormatter.php
Go to the documentation of this file.
1 <?php
36 class LogFormatter {
37  // Audience options for viewing usernames, comments, and actions
38  const FOR_PUBLIC = 1;
39  const FOR_THIS_USER = 2;
40 
41  // Static->
42 
48  public static function newFromEntry( LogEntry $entry ) {
49  global $wgLogActionsHandlers;
50  $fulltype = $entry->getFullType();
51  $wildcard = $entry->getType() . '/*';
52  $handler = '';
53 
54  if ( isset( $wgLogActionsHandlers[$fulltype] ) ) {
55  $handler = $wgLogActionsHandlers[$fulltype];
56  } elseif ( isset( $wgLogActionsHandlers[$wildcard] ) ) {
57  $handler = $wgLogActionsHandlers[$wildcard];
58  }
59 
60  if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
61  return new $handler( $entry );
62  }
63 
64  return new LegacyLogFormatter( $entry );
65  }
66 
74  public static function newFromRow( $row ) {
75  return self::newFromEntry( DatabaseLogEntry::newFromRow( $row ) );
76  }
77 
78  // Nonstatic->
79 
81  protected $entry;
82 
84  protected $audience = self::FOR_PUBLIC;
85 
87  public $context;
88 
90  protected $linkFlood = false;
91 
99  protected $plaintext = false;
100 
102  protected $irctext = false;
103 
104  protected function __construct( LogEntry $entry ) {
105  $this->entry = $entry;
106  $this->context = RequestContext::getMain();
107  }
108 
113  public function setContext( IContextSource $context ) {
114  $this->context = $context;
115  }
116 
123  public function setAudience( $audience ) {
124  $this->audience = ( $audience == self::FOR_THIS_USER )
125  ? self::FOR_THIS_USER
126  : self::FOR_PUBLIC;
127  }
128 
134  protected function canView( $field ) {
135  if ( $this->audience == self::FOR_THIS_USER ) {
137  $this->entry->getDeleted(), $field, $this->context->getUser() );
138  } else {
139  return !$this->entry->isDeleted( $field );
140  }
141  }
142 
149  public function setShowUserToolLinks( $value ) {
150  $this->linkFlood = $value;
151  }
152 
160  public function getPlainActionText() {
161  $this->plaintext = true;
162  $text = $this->getActionText();
163  $this->plaintext = false;
164 
165  return $text;
166  }
167 
174  public function getIRCActionComment() {
175  $actionComment = $this->getIRCActionText();
176  $comment = $this->entry->getComment();
177 
178  if ( $comment != '' ) {
179  if ( $actionComment == '' ) {
180  $actionComment = $comment;
181  } else {
182  $actionComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
183  }
184  }
185 
186  return $actionComment;
187  }
188 
195  public function getIRCActionText() {
197 
198  $this->plaintext = true;
199  $this->irctext = true;
200 
202  $parameters = $entry->getParameters();
203  // @see LogPage::actionText()
204  // Text of title the action is aimed at.
205  $target = $entry->getTarget()->getPrefixedText();
206  $text = null;
207  switch ( $entry->getType() ) {
208  case 'move':
209  switch ( $entry->getSubtype() ) {
210  case 'move':
211  $movesource = $parameters['4::target'];
212  $text = wfMessage( '1movedto2' )
213  ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
214  break;
215  case 'move_redir':
216  $movesource = $parameters['4::target'];
217  $text = wfMessage( '1movedto2_redir' )
218  ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
219  break;
220  case 'move-noredirect':
221  break;
222  case 'move_redir-noredirect':
223  break;
224  }
225  break;
226 
227  case 'delete':
228  switch ( $entry->getSubtype() ) {
229  case 'delete':
230  $text = wfMessage( 'deletedarticle' )
231  ->rawParams( $target )->inContentLanguage()->escaped();
232  break;
233  case 'restore':
234  $text = wfMessage( 'undeletedarticle' )
235  ->rawParams( $target )->inContentLanguage()->escaped();
236  break;
237  // @codingStandardsIgnoreStart Long line
238  //case 'revision': // Revision deletion
239  //case 'event': // Log deletion
240  // see https://github.com/wikimedia/mediawiki/commit/a9c243b7b5289dad204278dbe7ed571fd914e395
241  //default:
242  // @codingStandardsIgnoreEnd
243  }
244  break;
245 
246  case 'patrol':
247  // @codingStandardsIgnoreStart Long line
248  // https://github.com/wikimedia/mediawiki/commit/1a05f8faf78675dc85984f27f355b8825b43efff
249  // @codingStandardsIgnoreEnd
250  // Create a diff link to the patrolled revision
251  if ( $entry->getSubtype() === 'patrol' ) {
252  $diffLink = htmlspecialchars(
253  wfMessage( 'patrol-log-diff', $parameters['4::curid'] )
254  ->inContentLanguage()->text() );
255  $text = wfMessage( 'patrol-log-line', $diffLink, "[[$target]]", "" )
256  ->inContentLanguage()->text();
257  } else {
258  // broken??
259  }
260  break;
261 
262  case 'protect':
263  switch ( $entry->getSubtype() ) {
264  case 'protect':
265  $text = wfMessage( 'protectedarticle' )
266  ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
267  break;
268  case 'unprotect':
269  $text = wfMessage( 'unprotectedarticle' )
270  ->rawParams( $target )->inContentLanguage()->escaped();
271  break;
272  case 'modify':
273  $text = wfMessage( 'modifiedarticleprotection' )
274  ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
275  break;
276  case 'move_prot':
277  $text = wfMessage( 'movedarticleprotection' )
278  ->rawParams( $target, $parameters['4::oldtitle'] )->inContentLanguage()->escaped();
279  break;
280  }
281  break;
282 
283  case 'newusers':
284  switch ( $entry->getSubtype() ) {
285  case 'newusers':
286  case 'create':
287  $text = wfMessage( 'newuserlog-create-entry' )
288  ->inContentLanguage()->escaped();
289  break;
290  case 'create2':
291  case 'byemail':
292  $text = wfMessage( 'newuserlog-create2-entry' )
293  ->rawParams( $target )->inContentLanguage()->escaped();
294  break;
295  case 'autocreate':
296  $text = wfMessage( 'newuserlog-autocreate-entry' )
297  ->inContentLanguage()->escaped();
298  break;
299  }
300  break;
301 
302  case 'upload':
303  switch ( $entry->getSubtype() ) {
304  case 'upload':
305  $text = wfMessage( 'uploadedimage' )
306  ->rawParams( $target )->inContentLanguage()->escaped();
307  break;
308  case 'overwrite':
309  $text = wfMessage( 'overwroteimage' )
310  ->rawParams( $target )->inContentLanguage()->escaped();
311  break;
312  }
313  break;
314 
315  case 'rights':
316  if ( count( $parameters['4::oldgroups'] ) ) {
317  $oldgroups = implode( ', ', $parameters['4::oldgroups'] );
318  } else {
319  $oldgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
320  }
321  if ( count( $parameters['5::newgroups'] ) ) {
322  $newgroups = implode( ', ', $parameters['5::newgroups'] );
323  } else {
324  $newgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
325  }
326  switch ( $entry->getSubtype() ) {
327  case 'rights':
328  $text = wfMessage( 'rightslogentry' )
329  ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
330  break;
331  case 'autopromote':
332  $text = wfMessage( 'rightslogentry-autopromote' )
333  ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
334  break;
335  }
336  break;
337 
338  case 'merge':
339  $text = wfMessage( 'pagemerge-logentry' )
340  ->rawParams( $target, $parameters['4::dest'], $parameters['5::mergepoint'] )
341  ->inContentLanguage()->escaped();
342  break;
343 
344  case 'block':
345  switch ( $entry->getSubtype() ) {
346  case 'block':
347  // Keep compatibility with extensions by checking for
348  // new key (5::duration/6::flags) or old key (0/optional 1)
349  if ( $entry->isLegacy() ) {
350  $rawDuration = $parameters[0];
351  $rawFlags = isset( $parameters[1] ) ? $parameters[1] : '';
352  } else {
353  $rawDuration = $parameters['5::duration'];
354  $rawFlags = $parameters['6::flags'];
355  }
356  $duration = $wgContLang->translateBlockExpiry( $rawDuration );
357  $flags = BlockLogFormatter::formatBlockFlags( $rawFlags, $wgContLang );
358  $text = wfMessage( 'blocklogentry' )
359  ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
360  break;
361  case 'unblock':
362  $text = wfMessage( 'unblocklogentry' )
363  ->rawParams( $target )->inContentLanguage()->escaped();
364  break;
365  case 'reblock':
366  $duration = $wgContLang->translateBlockExpiry( $parameters['5::duration'] );
367  $flags = BlockLogFormatter::formatBlockFlags( $parameters['6::flags'], $wgContLang );
368  $text = wfMessage( 'reblock-logentry' )
369  ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
370  break;
371  }
372  break;
373 
374  case 'import':
375  switch ( $entry->getSubtype() ) {
376  case 'upload':
377  $text = wfMessage( 'import-logentry-upload' )
378  ->rawParams( $target )->inContentLanguage()->escaped();
379  break;
380  case 'interwiki':
381  $text = wfMessage( 'import-logentry-interwiki' )
382  ->rawParams( $target )->inContentLanguage()->escaped();
383  break;
384  }
385  break;
386  // case 'suppress' --private log -- aaron (so we know who to blame in a few years :-D)
387  // default:
388  }
389  if ( is_null( $text ) ) {
390  $text = $this->getPlainActionText();
391  }
392 
393  $this->plaintext = false;
394  $this->irctext = false;
395 
396  return $text;
397  }
398 
403  public function getActionText() {
404  if ( $this->canView( LogPage::DELETED_ACTION ) ) {
405  $element = $this->getActionMessage();
406  if ( $element instanceof Message ) {
407  $element = $this->plaintext ? $element->text() : $element->escaped();
408  }
409  if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
410  $element = $this->styleRestricedElement( $element );
411  }
412  } else {
413  $sep = $this->msg( 'word-separator' );
414  $sep = $this->plaintext ? $sep->text() : $sep->escaped();
415  $performer = $this->getPerformerElement();
416  $element = $performer . $sep . $this->getRestrictedElement( 'rev-deleted-event' );
417  }
418 
419  return $element;
420  }
421 
428  protected function getActionMessage() {
429  $message = $this->msg( $this->getMessageKey() );
430  $message->params( $this->getMessageParameters() );
431 
432  return $message;
433  }
434 
442  protected function getMessageKey() {
443  $type = $this->entry->getType();
444  $subtype = $this->entry->getSubtype();
445 
446  return "logentry-$type-$subtype";
447  }
448 
454  public function getActionLinks() {
455  return '';
456  }
457 
463  protected function extractParameters() {
465  $params = [];
466 
467  if ( $entry->isLegacy() ) {
468  foreach ( $entry->getParameters() as $index => $value ) {
469  $params[$index + 3] = $value;
470  }
471  }
472 
473  // Filter out parameters which are not in format #:foo
474  foreach ( $entry->getParameters() as $key => $value ) {
475  if ( strpos( $key, ':' ) === false ) {
476  continue;
477  }
478  list( $index, $type, ) = explode( ':', $key, 3 );
479  if ( ctype_digit( $index ) ) {
480  $params[$index - 1] = $this->formatParameterValue( $type, $value );
481  }
482  }
483 
484  /* Message class doesn't like non consecutive numbering.
485  * Fill in missing indexes with empty strings to avoid
486  * incorrect renumbering.
487  */
488  if ( count( $params ) ) {
489  $max = max( array_keys( $params ) );
490  // index 0 to 2 are added in getMessageParameters
491  for ( $i = 3; $i < $max; $i++ ) {
492  if ( !isset( $params[$i] ) ) {
493  $params[$i] = '';
494  }
495  }
496  }
497 
498  return $params;
499  }
500 
510  protected function getMessageParameters() {
511  if ( isset( $this->parsedParameters ) ) {
512  return $this->parsedParameters;
513  }
514 
516  $params = $this->extractParameters();
518  $params[1] = $this->canView( LogPage::DELETED_USER ) ? $entry->getPerformer()->getName() : '';
520 
521  // Bad things happens if the numbers are not in correct order
522  ksort( $params );
523 
524  $this->parsedParameters = $params;
525  return $this->parsedParameters;
526  }
527 
554  protected function formatParameterValue( $type, $value ) {
555  $saveLinkFlood = $this->linkFlood;
556 
557  switch ( strtolower( trim( $type ) ) ) {
558  case 'raw':
560  break;
561  case 'list':
562  $value = $this->context->getLanguage()->commaList( $value );
563  break;
564  case 'msg':
565  $value = $this->msg( $value )->text();
566  break;
567  case 'msg-content':
568  $value = $this->msg( $value )->inContentLanguage()->text();
569  break;
570  case 'number':
572  break;
573  case 'user':
575  $value = $user->getName();
576  break;
577  case 'user-link':
578  $this->setShowUserToolLinks( false );
579 
582 
583  $this->setShowUserToolLinks( $saveLinkFlood );
584  break;
585  case 'title':
587  $value = $title->getPrefixedText();
588  break;
589  case 'title-link':
592  break;
593  case 'plain':
594  // Plain text, nothing to do
595  default:
596  // Catch other types and use the old behavior (return as-is)
597  }
598 
599  return $value;
600  }
601 
611  protected function makePageLink( Title $title = null, $parameters = [], $html = null ) {
612  if ( !$this->plaintext ) {
613  $link = Linker::link( $title, $html, [], $parameters );
614  } else {
615  if ( !$title instanceof Title ) {
616  throw new MWException( "Expected title, got null" );
617  }
618  $link = '[[' . $title->getPrefixedText() . ']]';
619  }
620 
621  return $link;
622  }
623 
630  public function getPerformerElement() {
631  if ( $this->canView( LogPage::DELETED_USER ) ) {
632  $performer = $this->entry->getPerformer();
633  $element = $this->makeUserLink( $performer );
634  if ( $this->entry->isDeleted( LogPage::DELETED_USER ) ) {
635  $element = $this->styleRestricedElement( $element );
636  }
637  } else {
638  $element = $this->getRestrictedElement( 'rev-deleted-user' );
639  }
640 
641  return $element;
642  }
643 
648  public function getComment() {
649  if ( $this->canView( LogPage::DELETED_COMMENT ) ) {
650  $comment = Linker::commentBlock( $this->entry->getComment() );
651  // No hard coded spaces thanx
652  $element = ltrim( $comment );
653  if ( $this->entry->isDeleted( LogPage::DELETED_COMMENT ) ) {
654  $element = $this->styleRestricedElement( $element );
655  }
656  } else {
657  $element = $this->getRestrictedElement( 'rev-deleted-comment' );
658  }
659 
660  return $element;
661  }
662 
668  protected function getRestrictedElement( $message ) {
669  if ( $this->plaintext ) {
670  return $this->msg( $message )->text();
671  }
672 
673  $content = $this->msg( $message )->escaped();
674  $attribs = [ 'class' => 'history-deleted' ];
675 
676  return Html::rawElement( 'span', $attribs, $content );
677  }
678 
684  protected function styleRestricedElement( $content ) {
685  if ( $this->plaintext ) {
686  return $content;
687  }
688  $attribs = [ 'class' => 'history-deleted' ];
689 
690  return Html::rawElement( 'span', $attribs, $content );
691  }
692 
698  protected function msg( $key ) {
699  return $this->context->msg( $key );
700  }
701 
702  protected function makeUserLink( User $user, $toolFlags = 0 ) {
703  if ( $this->plaintext ) {
704  $element = $user->getName();
705  } else {
706  $element = Linker::userLink(
707  $user->getId(),
708  $user->getName()
709  );
710 
711  if ( $this->linkFlood ) {
712  $element .= Linker::userToolLinks(
713  $user->getId(),
714  $user->getName(),
715  true, // redContribsWhenNoEdits
716  $toolFlags,
717  $user->getEditCount()
718  );
719  }
720  }
721 
722  return $element;
723  }
724 
728  public function getPreloadTitles() {
729  return [];
730  }
731 
735  public function getMessageParametersForTesting() {
736  // This function was added because getMessageParameters() is
737  // protected and a change from protected to public caused
738  // problems with extensions
739  return $this->getMessageParameters();
740  }
741 
747  protected function getParametersForApi() {
748  return $this->entry->getParameters();
749  }
750 
765  public function formatParametersForApi() {
766  $logParams = [];
767  foreach ( $this->getParametersForApi() as $key => $value ) {
768  $vals = explode( ':', $key, 3 );
769  if ( count( $vals ) !== 3 ) {
770  $logParams[$key] = $value;
771  continue;
772  }
773  $logParams += $this->formatParameterValueForApi( $vals[2], $vals[1], $value );
774  }
775  ApiResult::setIndexedTagName( $logParams, 'param' );
776  ApiResult::setArrayType( $logParams, 'assoc' );
777 
778  return $logParams;
779  }
780 
790  protected function formatParameterValueForApi( $name, $type, $value ) {
791  $type = strtolower( trim( $type ) );
792  switch ( $type ) {
793  case 'bool':
794  $value = (bool)$value;
795  break;
796 
797  case 'number':
798  if ( ctype_digit( $value ) || is_int( $value ) ) {
799  $value = (int)$value;
800  } else {
801  $value = (float)$value;
802  }
803  break;
804 
805  case 'array':
806  case 'assoc':
807  case 'kvp':
808  if ( is_array( $value ) ) {
810  }
811  break;
812 
813  case 'timestamp':
815  break;
816 
817  case 'msg':
818  case 'msg-content':
819  $msg = $this->msg( $value );
820  if ( $type === 'msg-content' ) {
821  $msg->inContentLanguage();
822  }
823  $value = [];
824  $value["{$name}_key"] = $msg->getKey();
825  if ( $msg->getParams() ) {
826  $value["{$name}_params"] = $msg->getParams();
827  }
828  $value["{$name}_text"] = $msg->text();
829  return $value;
830 
831  case 'title':
832  case 'title-link':
834  if ( $title ) {
835  $value = [];
836  ApiQueryBase::addTitleInfo( $value, $title, "{$name}_" );
837  }
838  return $value;
839 
840  case 'user':
841  case 'user-link':
843  if ( $user ) {
844  $value = $user->getName();
845  }
846  break;
847 
848  default:
849  // do nothing
850  break;
851  }
852 
853  return [ $name => $value ];
854  }
855 }
856 
876  private $comment = null;
877 
885  private $revert = null;
886 
887  public function getComment() {
888  if ( $this->comment === null ) {
889  $this->comment = parent::getComment();
890  }
891 
892  // Make sure we execute the LogLine hook so that we immediately return
893  // the correct value.
894  if ( $this->revert === null ) {
895  $this->getActionLinks();
896  }
897 
898  return $this->comment;
899  }
900 
901  protected function getActionMessage() {
903  $action = LogPage::actionText(
904  $entry->getType(),
905  $entry->getSubtype(),
906  $entry->getTarget(),
907  $this->plaintext ? null : $this->context->getSkin(),
909  !$this->plaintext // whether to filter [[]] links
910  );
911 
912  $performer = $this->getPerformerElement();
913  if ( !$this->irctext ) {
914  $sep = $this->msg( 'word-separator' );
915  $sep = $this->plaintext ? $sep->text() : $sep->escaped();
916  $action = $performer . $sep . $action;
917  }
918 
919  return $action;
920  }
921 
922  public function getActionLinks() {
923  if ( $this->revert !== null ) {
924  return $this->revert;
925  }
926 
927  if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
928  $this->revert = '';
929  return $this->revert;
930  }
931 
932  $title = $this->entry->getTarget();
933  $type = $this->entry->getType();
934  $subtype = $this->entry->getSubtype();
935 
936  // Do nothing. The implementation is handled by the hook modifiying the
937  // passed-by-ref parameters. This also changes the default value so that
938  // getComment() and getActionLinks() do not call them indefinitely.
939  $this->revert = '';
940 
941  // This is to populate the $comment member of this instance so that it
942  // can be modified when calling the hook just below.
943  if ( $this->comment === null ) {
944  $this->getComment();
945  }
946 
947  $params = $this->entry->getParameters();
948 
949  Hooks::run( 'LogLine', [ $type, $subtype, $title, $params,
950  &$this->comment, &$this->revert, $this->entry->getTimestamp() ] );
951 
952  return $this->revert;
953  }
954 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
formatParameterValue($type, $value)
Formats parameters values dependent to their type.
isLegacy()
Whether the parameters for this log are stored in new or old format.
Definition: LogEntry.php:129
static rawParam($raw)
Definition: Message.php:985
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 & $html
Definition: hooks.txt:1936
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
Interface for objects which can provide a MediaWiki context on request.
getIRCActionText()
Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).
the array() calling protocol came about after MediaWiki 1.4rc1.
static newFromRow($row)
Handy shortcut for constructing a formatter directly from database row.
makeUserLink(User $user, $toolFlags=0)
static actionText($type, $action, $title=null, $skin=null, $params=[], $filterWikilinks=false)
Generate text for a log entry.
Definition: LogPage.php:227
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
setContext(IContextSource $context)
Replace the default context.
Interface for log entries.
Definition: LogEntry.php:36
canView($field)
Check if a log item can be displayed.
getParametersForApi()
Get the array of parameters, converted from legacy format if necessary.
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
LogEntryBase $entry
static newFromEntry(LogEntry $entry)
Constructs a new formatter suitable for given entry.
$comment
string null $revert
Cache for the result of getActionLinks() so that it does not need to run multiple times depending on ...
string $plaintext
Set to true if we are constructing a message text that is going to be included in page history or sen...
$value
msg($key)
Shortcut for wfMessage which honors local context.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
getSubtype()
The log subtype.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
getPerformer()
Get the user for performed this action.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2108
getMessageKey()
Returns a key to be used for formatting the action sentence.
getActionMessage()
Returns a sentence describing the log action.
getFullType()
The full logtype in format maintype/subtype.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getIRCActionComment()
Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).
const DELETED_COMMENT
Definition: LogPage.php:34
styleRestricedElement($content)
Helper method for styling restricted element.
static getMain()
Static methods.
__construct(LogEntry $entry)
getMessageParametersForTesting()
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 default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
getType()
The main log type.
This class formats all log entries for log types which have not been converted to the new system...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or etc which include things like revision author revision comment
Definition: hooks.txt:1156
$params
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:1936
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
const FOR_THIS_USER
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
IContextSource $context
Context for logging.
bool $linkFlood
Whether to output user tool links.
formatParametersForApi()
Format parameters for API output.
getPlainActionText()
Ugly hack to produce plaintext version of the message.
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
string null $comment
Backward compatibility for extension changing the comment from the LogLine hook.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
static link($target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
Definition: Linker.php:203
static formatBlockFlags($flags, $lang)
Convert a comma-delimited list of block log flags into a more readable (and translated) form...
getActionLinks()
Returns extra links that comes after the action text, like "revert", etc.
const DELETED_USER
Definition: LogPage.php:35
Implements the default log formatting.
static userLink($userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:984
const FOR_PUBLIC
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
getParameters()
Get the extra parameters stored for this message.
getId()
Get the user's ID.
Definition: User.php:2083
getPerformerElement()
Provides the name of the user who performed the log action.
setShowUserToolLinks($value)
If set to true, will produce user tool links after the user name.
static userCanBitfield($bitfield, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1046
static numParam($num)
Definition: Message.php:996
int $audience
Constant for handling log_deleted.
getEditCount()
Get the user's edit count.
Definition: User.php:3270
getMessageParameters()
Formats parameters intented for action message from array of all parameters.
static userToolLinks($userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:1017
extractParameters()
Extracts the optional extra parameters for use in action messages.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
makePageLink(Title $title=null, $parameters=[], $html=null)
Helper to make a link to the page, taking the plaintext value in consideration.
getActionText()
Gets the log action, including username.
static newFromRow($row)
Constructs new LogEntry from database result row.
Definition: LogEntry.php:201
getTarget()
Get the target page of this action.
getComment()
Gets the user provided comment.
const DELETED_ACTION
Definition: LogPage.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 probably a stub 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 modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:802
static commentBlock($comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
Definition: Linker.php:1525
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:730
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
setAudience($audience)
Set the visibility restrictions for displaying content.
formatParameterValueForApi($name, $type, $value)
Format a single parameter value for API output.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
getRestrictedElement($message)
Helper method for displaying restricted element.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300