138 parent::__construct();
143 $parser = MediaWikiServices::getInstance()->getParser();
144 $parser->setHook(
'downloadlink', [ $this,
'downloadLinkHook' ] );
145 $parser->setHook(
'doclink', [ $this,
'docLink' ] );
158 if ( isset(
$session[
'settings'] ) ) {
161 foreach ( $this->settings
as $key => $val ) {
168 if ( ( $this->
getVar(
'_InstallDone' ) || $this->
getVar(
'_UpgradeDone' ) )
169 && $this->
request->getVal(
'localsettings' )
175 $isCSS = $this->
request->getVal(
'css' );
181 $this->happyPages =
$session[
'happyPages'] ?? [];
183 $this->skippedPages =
$session[
'skippedPages'] ?? [];
187 # Special case for Creative Commons partner chooser box.
188 if ( $this->
request->getVal(
'SubmitCC' ) ) {
190 $this->output->useShortHeader();
191 $this->output->allowFrames();
197 if ( $this->
request->getVal(
'ShowCC' ) ) {
199 $this->output->useShortHeader();
200 $this->output->allowFrames();
201 $this->output->addHTML( $page->getCCDoneBox() );
207 $pageName = $this->
request->getVal(
'page' );
209 if ( in_array( $pageName, $this->otherPages ) ) {
215 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
216 $pageId = $lowestUnhappy;
218 $pageId = array_search( $pageName, $this->pageSequence );
221 # If necessary, move back to the lowest-numbered unhappy page
222 if ( $pageId > $lowestUnhappy ) {
223 $pageId = $lowestUnhappy;
224 if ( $lowestUnhappy == 0 ) {
225 # Knocked back to start, possible loss of session data.
226 $this->showSessionWarning =
true;
230 $pageName = $this->pageSequence[$pageId];
234 # If a back button was submitted, go back without submitting the form data.
235 if ( $this->
request->wasPosted() && $this->request->getBool(
'submit-back' ) ) {
236 if ( $this->
request->getVal(
'lastPage' ) ) {
237 $nextPage = $this->
request->getVal(
'lastPage' );
238 } elseif ( $pageId !==
false ) {
240 # Skip the skipped pages
241 $nextPageId = $pageId;
245 $nextPage = $this->pageSequence[$nextPageId];
246 }
while ( isset( $this->skippedPages[$nextPage] ) );
248 $nextPage = $this->pageSequence[$lowestUnhappy];
251 $this->output->redirect( $this->
getUrl( [
'page' => $nextPage ] ) );
257 $this->currentPageName = $page->getName();
260 if ( $page->isSlow() ) {
269 # Page skipped without explicit submission.
270 # Skip it when we click "back" so that we don't just go forward again.
271 $this->skippedPages[$pageName] =
true;
274 unset( $this->skippedPages[$pageName] );
277 # If it was posted, the page can request a continue to the next page.
278 if (
$result ===
'continue' && !$this->output->headerDone() ) {
279 if ( $pageId !==
false ) {
280 $this->happyPages[$pageId] =
true;
285 if ( $this->
request->getVal(
'lastPage' ) ) {
286 $nextPage = $this->
request->getVal(
'lastPage' );
287 } elseif ( $pageId !==
false ) {
288 $nextPage = $this->pageSequence[$pageId + 1];
290 $nextPage = $this->pageSequence[$lowestUnhappy];
293 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
294 $nextPage = $this->pageSequence[$lowestUnhappy];
297 $this->output->redirect( $this->
getUrl( [
'page' => $nextPage ] ) );
308 if ( count( $this->happyPages ) == 0 ) {
311 return max( array_keys( $this->happyPages ) ) + 1;
322 if (
wfIniGetBool(
'session.auto_start' ) || session_id() ) {
327 $this->phpErrors = [];
328 set_error_handler( [ $this,
'errorHandler' ] );
330 session_name(
'mw_installer_session' );
332 }
catch ( Exception
$e ) {
333 restore_error_handler();
336 restore_error_handler();
338 if ( $this->phpErrors ) {
355 $url = $this->
request->getFullRequestURL();
356 if ( preg_match(
'!^(.*\?)!', $url, $m ) ) {
360 if ( preg_match(
'!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
367 'local path' => dirname( __DIR__ ),
379 if ( !( $msg instanceof
Message ) ) {
380 $args = func_get_args();
381 array_shift(
$args );
382 $args = array_map(
'htmlspecialchars',
$args );
385 $text = $msg->useDatabase(
false )->plain();
386 $this->output->addHTML( $this->
getErrorBox( $text ) );
396 $this->phpErrors[] = $errstr;
405 $this->output->output();
419 $this->happyPages = [];
431 $url = $this->
request->getRequestURL();
432 # Remove existing query
433 $url = preg_replace(
'/\?.*$/',
'', $url );
449 $pageClass =
'WebInstaller' . $pageName;
451 return new $pageClass( $this );
463 return $this->session[
$name] ?? $default;
482 return $this->tabIndex++;
494 RequestContext::getMain()->setLanguage(
$wgLang );
495 $this->
setVar(
'wgLanguageCode', $wgLanguageCode );
496 $this->
setVar(
'_UserLang', $wgLanguageCode );
500 $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
511 $mwLanguages = Language::fetchLanguageNames(
null,
'mwfile' );
512 $headerLanguages = array_keys(
$wgRequest->getAcceptLang() );
514 foreach ( $headerLanguages
as $lang ) {
515 if ( isset( $mwLanguages[
$lang] ) ) {
529 $s =
"<div class=\"config-page-wrapper\">\n";
530 $s .=
"<div class=\"config-page\">\n";
531 $s .=
"<div class=\"config-page-list\"><ul>\n";
534 foreach ( $this->pageSequence
as $id => $pageName ) {
535 $happy = !empty( $this->happyPages[$id] );
538 $happy || $lastHappy == $id - 1,
547 $s .=
"</ul><br/><ul>\n";
550 $s .=
"</ul></div>\n";
557 $s .= Html::element(
'h2', [],
560 $this->output->addHTMLNoFlush(
$s );
573 $s =
"<li class=\"config-page-list-item\">";
580 $name =
wfMessage(
'config-page-' . strtolower( $pageName ) )->text();
583 $query = [
'page' => $pageName ];
585 if ( !in_array( $pageName, $this->pageSequence ) ) {
590 $link = Html::element(
'a',
601 $s .=
"<span class=\"config-page-current\">$link</span>";
606 $s .= Html::element(
'span',
608 'class' =>
'config-page-disabled'
623 $this->output->addHTMLNoFlush(
624 "<div class=\"visualClear\"></div>\n" .
626 "<div class=\"visualClear\"></div>\n" .
638 return $this->
getInfoBox( $text,
'critical-32.png',
'config-error-box' );
649 return $this->
getInfoBox( $text,
'warning-32.png',
'config-warning-box' );
661 public function getInfoBox( $text, $icon =
false, $class =
false ) {
662 $text = $this->
parse( $text,
true );
663 $icon = ( $icon ==
false ) ?
664 'images/info-32.png' :
666 $alt =
wfMessage(
'config-information' )->text();
668 return Html::infoBox( $text, $icon, $alt, $class );
679 $args = func_get_args();
680 array_shift(
$args );
681 $args = array_map(
'htmlspecialchars',
$args );
685 return "<div class=\"config-help-field-container\">\n" .
686 "<span class=\"config-help-field-hint\" title=\"" .
687 wfMessage(
'config-help-tooltip' )->escaped() .
"\">" .
688 wfMessage(
'config-help' )->escaped() .
"</span>\n" .
689 "<div class=\"config-help-field-data\">" .
$html .
"</div>\n" .
698 $args = func_get_args();
700 $this->output->addHTML(
$html );
710 $args = func_get_args();
711 array_shift(
$args );
712 $html =
'<div class="config-message">' .
715 $this->output->addHTML(
$html );
722 $errors = array_merge(
$status->getErrorsArray(),
$status->getWarningsArray() );
723 foreach ( $errors
as $error ) {
738 public function label( $msg, $forId, $contents, $helpData =
"" ) {
739 if ( strval( $msg ) ==
'' ) {
740 $labelText =
"\u{00A0}";
742 $labelText =
wfMessage( $msg )->escaped();
745 $attributes = [
'class' =>
'config-label' ];
748 $attributes[
'for'] = $forId;
751 return "<div class=\"config-block\">\n" .
752 " <div class=\"config-block-label\">\n" .
759 " <div class=\"config-block-elements\">\n" .
780 if ( !isset(
$params[
'controlName'] ) ) {
784 if ( !isset(
$params[
'value'] ) ) {
788 if ( !isset(
$params[
'attribs'] ) ) {
791 if ( !isset(
$params[
'help'] ) ) {
803 'id' =>
$params[
'controlName'],
804 'class' =>
'config-input-text',
827 if ( !isset(
$params[
'controlName'] ) ) {
831 if ( !isset(
$params[
'value'] ) ) {
835 if ( !isset(
$params[
'attribs'] ) ) {
838 if ( !isset(
$params[
'help'] ) ) {
851 'id' =>
$params[
'controlName'],
852 'class' =>
'config-input-text',
876 if ( !isset(
$params[
'value'] ) ) {
880 if ( !isset(
$params[
'attribs'] ) ) {
885 $params[
'attribs'][
'type'] =
'password';
906 if ( !isset(
$params[
'controlName'] ) ) {
910 if ( !isset(
$params[
'value'] ) ) {
914 if ( !isset(
$params[
'attribs'] ) ) {
917 if ( !isset(
$params[
'help'] ) ) {
920 if ( !isset(
$params[
'labelAttribs'] ) ) {
925 return "<div class=\"config-input-check\">\n" .
934 'id' =>
$params[
'controlName'],
965 $label =
$params[
'label'] ??
'';
967 if ( !isset(
$params[
'controlName'] ) ) {
971 if ( !isset(
$params[
'help'] ) ) {
976 foreach ( $items
as $value => $item ) {
977 $s .=
"<li>$item</li>\n";
993 if ( !isset(
$params[
'controlName'] ) ) {
997 if ( !isset(
$params[
'value'] ) ) {
1006 if ( isset(
$params[
'commonAttribs'] ) ) {
1007 $itemAttribs =
$params[
'commonAttribs'];
1011 $itemAttribs =
$params[
'itemAttribs'][
$value] + $itemAttribs;
1016 $itemAttribs[
'id'] = $id;
1020 Xml::radio(
$params[
'controlName'],
$value, $checked, $itemAttribs ) .
1022 Xml::tags(
'label', [
'for' => $id ], $this->
parse(
1023 isset(
$params[
'itemLabels'] ) ?
1039 $text =
$status->getWikiText();
1047 $this->output->addHTML( $box );
1064 foreach ( $varNames
as $name ) {
1067 if ( stripos(
$name,
'password' ) ===
false ) {
1074 $this->
setVar( $name,
false );
1075 } elseif ( stripos(
$name,
'password' ) !==
false ) {
1093 $query = [
'page' => $page ];
1095 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1114 return Html::element(
'a', [
'href' => $url ], $linkText );
1127 $anchor = Html::rawElement(
'a',
1128 [
'href' => $this->
getUrl( [
'localsettings' => 1 ] ) ],
1132 return Html::rawElement(
'div', [
'class' =>
'config-download-link' ], $anchor );
1157 if ( !empty( $_SERVER[
'PHP_SELF'] ) ) {
1158 $path = $_SERVER[
'PHP_SELF'];
1159 } elseif ( !empty( $_SERVER[
'SCRIPT_NAME'] ) ) {
1160 $path = $_SERVER[
'SCRIPT_NAME'];
1162 if (
$path ===
false ) {
1167 return parent::envCheckPath();
1171 parent::envPrepPath();
1176 if ( !empty( $_SERVER[
'PHP_SELF'] ) ) {
1177 $path = $_SERVER[
'PHP_SELF'];
1178 } elseif ( !empty( $_SERVER[
'SCRIPT_NAME'] ) ) {
1179 $path = $_SERVER[
'SCRIPT_NAME'];
1181 if (
$path !==
false ) {
1182 $scriptPath = preg_replace(
'{^(.*)/(mw-)?config.*$}',
'$1',
$path );
1184 $this->
setVar(
'wgScriptPath',
"$scriptPath" );
1186 $this->
setVar(
'wgScript',
"$scriptPath/index.php" );
1187 $this->
setVar(
'wgLoadScript',
"$scriptPath/load.php" );
1188 $this->
setVar(
'wgStylePath',
"$scriptPath/skins" );
1189 $this->
setVar(
'wgLocalStylePath',
"$scriptPath/skins" );
1190 $this->
setVar(
'wgExtensionAssetsPath',
"$scriptPath/extensions" );
1191 $this->
setVar(
'wgUploadPath',
"$scriptPath/images" );
1192 $this->
setVar(
'wgResourceBasePath',
"$scriptPath" );
1200 return WebRequest::detectServer();
1209 $this->
request->response()->header(
'Content-type: application/x-httpd-php' );
1210 $this->
request->response()->header(
1211 'Content-Disposition: attachment; filename="LocalSettings.php"'
1215 $rightsProfile = $this->rightsProfiles[$this->
getVar(
'_RightsProfile' )];
1216 foreach ( $rightsProfile
as $group => $rightsArr ) {
1217 $ls->setGroupRights( $group, $rightsArr );
1219 echo $ls->getText();
1226 $this->
request->response()->header(
'Content-type: text/css' );
1227 echo $this->output->getCSS();
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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
$wgLanguageCode
Site language code.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
if(! $wgDBerrorLogTZ) $wgRequest
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
disableTimeLimit()
Disable the time limit for execution.
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
The Message class provides methods which fulfil two basic services:
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Output class modelled on OutputPage.
Class for the core installer web interface.
setupLanguage()
Initializes language-related variables.
getHelpBox( $msg)
Get small text indented help for a preceding form field.
WebInstallerOutput $output
finish()
Clean up from execute()
getTextBox( $params)
Get a labelled text box to configure a variable.
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
nextTabIndex()
Get the next tabindex attribute value.
startPageWrapper( $currentPageName)
Called by execute() before page output starts, to show a page list.
showStatusBox( $status)
Output an error or warning box using a Status object.
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
getPageByName( $pageName)
Get a WebInstallerPage by name.
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
bool[] $happyPages
Array of pages which have declared that they have been submitted, have validated their input,...
getSession( $name, $default=null)
Get a session variable.
outputCss()
Output stylesheet for web installer pages.
getLowestUnhappy()
Find the next page in sequence that hasn't been completed.
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it.
execute(array $session)
Main entry point.
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location,...
getDocUrl( $page)
Helper for Installer::docLink()
bool[] $skippedPages
List of "skipped" pages.
showHelpBox( $msg)
Output a help box.
endPageWrapper()
Output some stuff after a page is finished.
outputLS()
Actually output LocalSettings.php for download.
downloadLinkHook( $text, $attribs, $parser)
Helper for "Download LocalSettings" link on WebInstall_Complete.
getRadioElements( $params)
Get a set of labelled radio buttons.
setSession( $name, $value)
Set a session variable.
reset()
We're restarting the installation, reset the session, happyPages, etc.
string $currentPageName
Name of the page we're on.
getRadioSet( $params)
Get a set of labelled radio buttons.
getWarningBox( $text)
Get HTML for a warning box with an icon.
getPasswordBox( $params)
Get a labelled password box to configure a variable.
WebRequest $request
WebRequest object.
__construct(WebRequest $request)
getTextArea( $params)
Get a labelled textarea to configure a variable.
getFingerprint()
Get a hash of data identifying this MW installation.
string[] $otherPages
Out of sequence pages, selectable by the user at any time.
string[] $pageSequence
The main sequence of page names.
string[] $phpErrors
Captured PHP error text.
showError( $msg)
Show an error message in a box.
bool $showSessionWarning
Flag indicating that session data may have been lost.
getErrorBox( $text)
Get HTML for an error box with an icon.
getPageListItem( $pageName, $enabled, $currentPageName)
Get a list item for the page list.
showStatusMessage(Status $status)
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an info box with an icon.
docLink( $linkText, $attribs, $parser)
Extension tag hook for a documentation link.
startSession()
Start the PHP session.
int $tabIndex
Numeric index of the page we're on.
array[] $session
Cached session array.
getUrl( $query=[])
Get a URL for submission back to the same script.
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
showMessage( $msg)
Show a short informational message.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
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
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration settings
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
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=(\d*-\d*)") 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
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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
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 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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Allows to change the fields on the form that will be generated $name
returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set this hook should only be used to add variables that depend on the current page request
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
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
processing should stop and the error should be shown to the user * false
returning false will NOT prevent logging $e
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
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
if(!isset( $args[0])) $lang