MediaWiki  REL1_31
FileDeleteForm.php
Go to the documentation of this file.
1 <?php
25 
32 
36  private $title = null;
37 
41  private $file = null;
42 
46  private $oldfile = null;
47  private $oldimage = '';
48 
52  public function __construct( $file ) {
53  $this->title = $file->getTitle();
54  $this->file = $file;
55  }
56 
61  public function execute() {
63 
64  $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
65  if ( count( $permissionErrors ) ) {
66  throw new PermissionsError( 'delete', $permissionErrors );
67  }
68 
69  if ( wfReadOnly() ) {
70  throw new ReadOnlyError;
71  }
72 
73  if ( $wgUploadMaintenance ) {
74  throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
75  }
76 
77  $this->setHeaders();
78 
79  $this->oldimage = $wgRequest->getText( 'oldimage', false );
80  $token = $wgRequest->getText( 'wpEditToken' );
81  # Flag to hide all contents of the archived revisions
82  $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
83 
84  if ( $this->oldimage ) {
85  $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
86  $this->title,
87  $this->oldimage
88  );
89  }
90 
91  if ( !self::haveDeletableFile( $this->file, $this->oldfile, $this->oldimage ) ) {
92  $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
93  $wgOut->addReturnTo( $this->title );
94  return;
95  }
96 
97  // Perform the deletion if appropriate
98  if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
99  $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
100  $deleteReason = $wgRequest->getText( 'wpReason' );
101 
102  if ( $deleteReasonList == 'other' ) {
103  $reason = $deleteReason;
104  } elseif ( $deleteReason != '' ) {
105  // Entry from drop down menu + additional comment
106  $reason = $deleteReasonList . wfMessage( 'colon-separator' )
107  ->inContentLanguage()->text() . $deleteReason;
108  } else {
109  $reason = $deleteReasonList;
110  }
111 
113  $this->title,
114  $this->file,
115  $this->oldimage,
116  $reason,
117  $suppress,
118  $wgUser
119  );
120 
121  if ( !$status->isGood() ) {
122  $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
123  $wgOut->addWikiText( '<div class="error">' .
124  $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
125  . '</div>' );
126  }
127  if ( $status->isOK() ) {
128  $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
129  $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
130  // Return to the main page if we just deleted all versions of the
131  // file, otherwise go back to the description page
132  $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
133 
134  WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
135  }
136  return;
137  }
138 
139  $this->showForm();
140  $this->showLogEntries();
141  }
142 
156  public static function doDelete( &$title, &$file, &$oldimage, $reason,
157  $suppress, User $user = null, $tags = []
158  ) {
159  if ( $user === null ) {
160  global $wgUser;
161  $user = $wgUser;
162  }
163 
164  if ( $oldimage ) {
165  $page = null;
166  $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
167  if ( $status->ok ) {
168  // Need to do a log item
169  $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
170  if ( trim( $reason ) != '' ) {
171  $logComment .= wfMessage( 'colon-separator' )
172  ->inContentLanguage()->text() . $reason;
173  }
174 
175  $logtype = $suppress ? 'suppress' : 'delete';
176 
177  $logEntry = new ManualLogEntry( $logtype, 'delete' );
178  $logEntry->setPerformer( $user );
179  $logEntry->setTarget( $title );
180  $logEntry->setComment( $logComment );
181  $logEntry->setTags( $tags );
182  $logid = $logEntry->insert();
183  $logEntry->publish( $logid );
184 
185  $status->value = $logid;
186  }
187  } else {
188  $status = Status::newFatal( 'cannotdelete',
190  );
191  $page = WikiPage::factory( $title );
192  $dbw = wfGetDB( DB_MASTER );
193  $dbw->startAtomic( __METHOD__ );
194  // delete the associated article first
195  $error = '';
196  $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
197  $user, $tags );
198  // doDeleteArticleReal() returns a non-fatal error status if the page
199  // or revision is missing, so check for isOK() rather than isGood()
200  if ( $deleteStatus->isOK() ) {
201  $status = $file->delete( $reason, $suppress, $user );
202  if ( $status->isOK() ) {
203  if ( $deleteStatus->value === null ) {
204  // No log ID from doDeleteArticleReal(), probably
205  // because the page/revision didn't exist, so create
206  // one here.
207  $logtype = $suppress ? 'suppress' : 'delete';
208  $logEntry = new ManualLogEntry( $logtype, 'delete' );
209  $logEntry->setPerformer( $user );
210  $logEntry->setTarget( clone $title );
211  $logEntry->setComment( $reason );
212  $logEntry->setTags( $tags );
213  $logid = $logEntry->insert();
214  $dbw->onTransactionPreCommitOrIdle(
215  function () use ( $dbw, $logEntry, $logid ) {
216  $logEntry->publish( $logid );
217  },
218  __METHOD__
219  );
220  $status->value = $logid;
221  } else {
222  $status->value = $deleteStatus->value; // log id
223  }
224  $dbw->endAtomic( __METHOD__ );
225  } else {
226  // Page deleted but file still there? rollback page delete
227  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
228  $lbFactory->rollbackMasterChanges( __METHOD__ );
229  }
230  } else {
231  // Done; nothing changed
232  $dbw->endAtomic( __METHOD__ );
233  }
234  }
235 
236  if ( $status->isOK() ) {
237  Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
238  }
239 
240  return $status;
241  }
242 
246  private function showForm() {
248 
249  $conf = RequestContext::getMain()->getConfig();
250  $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
251 
252  if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
253  $suppress = "<tr id=\"wpDeleteSuppressRow\">
254  <td></td>
255  <td class='mw-input'><strong>" .
256  Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
257  'wpSuppress', 'wpSuppress', false, [ 'tabindex' => '3' ] ) .
258  "</strong></td>
259  </tr>";
260  } else {
261  $suppress = '';
262  }
263 
264  $wgOut->addModules( 'mediawiki.action.delete.file' );
265 
266  $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
267  $form = Xml::openElement( 'form', [ 'method' => 'post', 'action' => $this->getAction(),
268  'id' => 'mw-img-deleteconfirm' ] ) .
269  Xml::openElement( 'fieldset' ) .
270  Xml::element( 'legend', null, wfMessage( 'filedelete-legend' )->text() ) .
271  Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) ) .
272  $this->prepareMessage( 'filedelete-intro' ) .
273  Xml::openElement( 'table', [ 'id' => 'mw-img-deleteconfirm-table' ] ) .
274  "<tr>
275  <td class='mw-label'>" .
276  Xml::label( wfMessage( 'filedelete-comment' )->text(), 'wpDeleteReasonList' ) .
277  "</td>
278  <td class='mw-input'>" .
280  'wpDeleteReasonList',
281  wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
282  wfMessage( 'filedelete-reason-otherlist' )->inContentLanguage()->text(),
283  '',
284  'wpReasonDropDown',
285  1
286  ) .
287  "</td>
288  </tr>
289  <tr>
290  <td class='mw-label'>" .
291  Xml::label( wfMessage( 'filedelete-otherreason' )->text(), 'wpReason' ) .
292  "</td>
293  <td class='mw-input'>" .
294  Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ), [
295  'type' => 'text',
296  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
297  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
298  // Unicode codepoints (or 255 UTF-8 bytes for old schema).
299  'maxlength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
300  'tabindex' => '2',
301  'id' => 'wpReason'
302  ] ) .
303  "</td>
304  </tr>
305  {$suppress}";
306  if ( $wgUser->isLoggedIn() ) {
307  $form .= "
308  <tr>
309  <td></td>
310  <td class='mw-input'>" .
311  Xml::checkLabel( wfMessage( 'watchthis' )->text(),
312  'wpWatch', 'wpWatch', $checkWatch, [ 'tabindex' => '3' ] ) .
313  "</td>
314  </tr>";
315  }
316  $form .= "
317  <tr>
318  <td></td>
319  <td class='mw-submit'>" .
321  wfMessage( 'filedelete-submit' )->text(),
322  [
323  'name' => 'mw-filedelete-submit',
324  'id' => 'mw-filedelete-submit',
325  'tabindex' => '4'
326  ]
327  ) .
328  "</td>
329  </tr>" .
330  Xml::closeElement( 'table' ) .
331  Xml::closeElement( 'fieldset' ) .
332  Xml::closeElement( 'form' );
333 
334  if ( $wgUser->isAllowed( 'editinterface' ) ) {
335  $title = wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle();
336  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
337  $link = $linkRenderer->makeKnownLink(
338  $title,
339  wfMessage( 'filedelete-edit-reasonlist' )->text(),
340  [],
341  [ 'action' => 'edit' ]
342  );
343  $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
344  }
345 
346  $wgOut->addHTML( $form );
347  }
348 
352  private function showLogEntries() {
353  global $wgOut;
354  $deleteLogPage = new LogPage( 'delete' );
355  $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
356  LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
357  }
358 
367  private function prepareMessage( $message ) {
368  global $wgLang;
369  if ( $this->oldimage ) {
370  # Message keys used:
371  # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
372  return wfMessage(
373  "{$message}-old",
374  wfEscapeWikiText( $this->title->getText() ),
375  $wgLang->date( $this->getTimestamp(), true ),
376  $wgLang->time( $this->getTimestamp(), true ),
377  wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
378  } else {
379  return wfMessage(
380  $message,
381  wfEscapeWikiText( $this->title->getText() )
382  )->parseAsBlock();
383  }
384  }
385 
389  private function setHeaders() {
390  global $wgOut;
391  $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
392  $wgOut->setRobotPolicy( 'noindex,nofollow' );
393  $wgOut->addBacklinkSubtitle( $this->title );
394  }
395 
402  public static function isValidOldSpec( $oldimage ) {
403  return strlen( $oldimage ) >= 16
404  && strpos( $oldimage, '/' ) === false
405  && strpos( $oldimage, '\\' ) === false;
406  }
407 
418  public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
419  return $oldimage
420  ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
421  : $file && $file->exists() && $file->isLocal();
422  }
423 
429  private function getAction() {
430  $q = [];
431  $q['action'] = 'delete';
432 
433  if ( $this->oldimage ) {
434  $q['oldimage'] = $this->oldimage;
435  }
436 
437  return $this->title->getLocalURL( $q );
438  }
439 
445  private function getTimestamp() {
446  return $this->oldfile->getTimestamp();
447  }
448 }
ReadOnlyError
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Definition: ReadOnlyError.php:28
$user
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 account $user
Definition: hooks.txt:247
$wgUser
$wgUser
Definition: Setup.php:902
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
wfMessage
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 unset offset - wrap String Wrap the message in html(usually something like "&lt
Xml\label
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:359
text
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:18
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:586
$wgUploadMaintenance
$wgUploadMaintenance
To disable file delete/restore temporarily.
Definition: DefaultSettings.php:8544
Title\getPrefixedText
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1625
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
FileDeleteForm\__construct
__construct( $file)
Definition: FileDeleteForm.php:52
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1262
File\delete
delete( $reason, $suppress=false, $user=null)
Delete all versions of the file.
Definition: File.php:1950
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
FileDeleteForm\getTimestamp
getTimestamp()
Extract the timestamp of the old version.
Definition: FileDeleteForm.php:445
$linkRenderer
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 after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:2056
Xml\openElement
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
php
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:37
File\exists
exists()
Returns true if file exists in the repository.
Definition: File.php:896
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:106
FileDeleteForm\getAction
getAction()
Prepare the form action.
Definition: FileDeleteForm.php:429
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
title
title
Definition: parserTests.txt:219
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:232
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
FileDeleteForm
File deletion user interface.
Definition: FileDeleteForm.php:31
WatchAction\doWatchOrUnwatch
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
Definition: WatchAction.php:91
$wgLang
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 $wgLang
Definition: design.txt:56
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
LogEventsList\showLogExtract
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Definition: LogEventsList.php:616
DB_MASTER
const DB_MASTER
Definition: defines.php:26
FileDeleteForm\$oldfile
File $oldfile
Definition: FileDeleteForm.php:46
MIGRATION_OLD
const MIGRATION_OLD
Definition: Defines.php:302
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
FileDeleteForm\prepareMessage
prepareMessage( $message)
Prepare a message referring to the file being deleted, showing an appropriate message depending upon ...
Definition: FileDeleteForm.php:367
FileDeleteForm\showForm
showForm()
Show the confirmation form.
Definition: FileDeleteForm.php:246
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
FileDeleteForm\$oldimage
$oldimage
Definition: FileDeleteForm.php:47
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, 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. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
CommentStore\COMMENT_CHARACTER_LIMIT
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
Definition: CommentStore.php:37
File\getTitle
getTitle()
Return the associated title object.
Definition: File.php:326
Title
Represents a title within MediaWiki.
Definition: Title.php:39
FileDeleteForm\execute
execute()
Fulfil the request; shows the form or deletes the file, pending authentication, confirmation,...
Definition: FileDeleteForm.php:61
FileDeleteForm\$file
File $file
Definition: FileDeleteForm.php:41
Xml\closeElement
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:118
Xml\listDropDown
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
Definition: Xml.php:509
FileDeleteForm\showLogEntries
showLogEntries()
Show deletion log fragments pertaining to the current file.
Definition: FileDeleteForm.php:352
File\isLocal
isLocal()
Returns true if the file comes from the local file repository.
Definition: File.php:1856
FileDeleteForm\setHeaders
setHeaders()
Set headers, titles and other bits.
Definition: FileDeleteForm.php:389
FileDeleteForm\$title
Title $title
Definition: FileDeleteForm.php:36
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:432
FileDeleteForm\doDelete
static doDelete(&$title, &$file, &$oldimage, $reason, $suppress, User $user=null, $tags=[])
Really delete the file.
Definition: FileDeleteForm.php:156
Xml\input
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:275
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:737
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
$wgOut
$wgOut
Definition: Setup.php:912
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
FileDeleteForm\haveDeletableFile
static haveDeletableFile(&$file, &$oldfile, $oldimage)
Could we delete the file specified? If an oldimage value was provided, does it correspond to an exist...
Definition: FileDeleteForm.php:418
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:521
Xml\submitButton
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:460
Xml\checkLabel
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:420
FileDeleteForm\isValidOldSpec
static isValidOldSpec( $oldimage)
Is the provided oldimage value valid?
Definition: FileDeleteForm.php:402