Go to the documentation of this file.
138 parent::__construct();
144 $wgParser->setHook(
'downloadlink', [ $this,
'downloadLinkHook' ] );
145 $wgParser->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 if ( isset(
$session[
'happyPages'] ) ) {
182 $this->happyPages =
$session[
'happyPages'];
184 $this->happyPages = [];
187 if ( isset(
$session[
'skippedPages'] ) ) {
188 $this->skippedPages =
$session[
'skippedPages'];
190 $this->skippedPages = [];
195 # Special case for Creative Commons partner chooser box.
196 if ( $this->
request->getVal(
'SubmitCC' ) ) {
198 $this->
output->useShortHeader();
199 $this->
output->allowFrames();
205 if ( $this->
request->getVal(
'ShowCC' ) ) {
207 $this->
output->useShortHeader();
208 $this->
output->allowFrames();
209 $this->
output->addHTML( $page->getCCDoneBox() );
215 $pageName = $this->
request->getVal(
'page' );
217 if ( in_array( $pageName, $this->otherPages ) ) {
223 if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
224 $pageId = $lowestUnhappy;
226 $pageId = array_search( $pageName, $this->pageSequence );
229 # If necessary, move back to the lowest-numbered unhappy page
230 if ( $pageId > $lowestUnhappy ) {
231 $pageId = $lowestUnhappy;
232 if ( $lowestUnhappy == 0 ) {
233 # Knocked back to start, possible loss of session data.
234 $this->showSessionWarning =
true;
238 $pageName = $this->pageSequence[$pageId];
242 # If a back button was submitted, go back without submitting the form data.
243 if ( $this->
request->wasPosted() && $this->
request->getBool(
'submit-back' ) ) {
244 if ( $this->
request->getVal(
'lastPage' ) ) {
245 $nextPage = $this->
request->getVal(
'lastPage' );
246 } elseif ( $pageId !==
false ) {
248 # Skip the skipped pages
249 $nextPageId = $pageId;
253 $nextPage = $this->pageSequence[$nextPageId];
254 }
while ( isset( $this->skippedPages[$nextPage] ) );
256 $nextPage = $this->pageSequence[$lowestUnhappy];
259 $this->
output->redirect( $this->
getUrl( [
'page' => $nextPage ] ) );
265 $this->currentPageName = $page->getName();
268 if ( $page->isSlow() ) {
277 # Page skipped without explicit submission.
278 # Skip it when we click "back" so that we don't just go forward again.
279 $this->skippedPages[$pageName] =
true;
282 unset( $this->skippedPages[$pageName] );
285 # If it was posted, the page can request a continue to the next page.
286 if (
$result ===
'continue' && !$this->
output->headerDone() ) {
287 if ( $pageId !==
false ) {
288 $this->happyPages[$pageId] =
true;
293 if ( $this->
request->getVal(
'lastPage' ) ) {
294 $nextPage = $this->
request->getVal(
'lastPage' );
295 } elseif ( $pageId !==
false ) {
296 $nextPage = $this->pageSequence[$pageId + 1];
298 $nextPage = $this->pageSequence[$lowestUnhappy];
301 if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
302 $nextPage = $this->pageSequence[$lowestUnhappy];
305 $this->
output->redirect( $this->
getUrl( [
'page' => $nextPage ] ) );
316 if (
count( $this->happyPages ) == 0 ) {
319 return max( array_keys( $this->happyPages ) ) + 1;
330 if (
wfIniGetBool(
'session.auto_start' ) || session_id() ) {
335 $this->phpErrors = [];
336 set_error_handler( [ $this,
'errorHandler' ] );
338 session_name(
'mw_installer_session' );
340 }
catch ( Exception
$e ) {
341 restore_error_handler();
344 restore_error_handler();
346 if ( $this->phpErrors ) {
363 $url = $this->
request->getFullRequestURL();
364 if ( preg_match(
'!^(.*\?)!', $url, $m ) ) {
368 if ( preg_match(
'!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
375 'local path' => dirname( __DIR__ ),
387 if ( !( $msg instanceof Message ) ) {
388 $args = func_get_args();
389 array_shift(
$args );
390 $args = array_map(
'htmlspecialchars',
$args );
393 $text = $msg->useDatabase(
false )->plain();
404 $this->phpErrors[] = $errstr;
427 $this->happyPages = [];
439 $url = $this->
request->getRequestURL();
440 # Remove existing query
441 $url = preg_replace(
'/\?.*$/',
'', $url );
457 $pageClass =
'WebInstaller' . $pageName;
459 return new $pageClass( $this );
471 if ( !isset( $this->session[
$name] ) ) {
474 return $this->session[
$name];
494 return $this->tabIndex++;
507 $this->
setVar(
'wgLanguageCode', $wgLanguageCode );
508 $this->
setVar(
'_UserLang', $wgLanguageCode );
512 $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
524 $headerLanguages = array_keys(
$wgRequest->getAcceptLang() );
526 foreach ( $headerLanguages
as $lang ) {
527 if ( isset( $mwLanguages[
$lang] ) ) {
541 $s =
"<div class=\"config-page-wrapper\">\n";
542 $s .=
"<div class=\"config-page\">\n";
543 $s .=
"<div class=\"config-page-list\"><ul>\n";
546 foreach ( $this->pageSequence
as $id => $pageName ) {
547 $happy = !empty( $this->happyPages[$id] );
550 $happy || $lastHappy == $id - 1,
559 $s .=
"</ul><br/><ul>\n";
562 $s .=
"</ul></div>\n";
572 $this->
output->addHTMLNoFlush(
$s );
585 $s =
"<li class=\"config-page-list-item\">";
592 $name =
wfMessage(
'config-page-' . strtolower( $pageName ) )->text();
595 $query = [
'page' => $pageName ];
597 if ( !in_array( $pageName, $this->pageSequence ) ) {
613 $s .=
"<span class=\"config-page-current\">$link</span>";
620 'class' =>
'config-page-disabled'
635 $this->
output->addHTMLNoFlush(
636 "<div class=\"visualClear\"></div>\n" .
638 "<div class=\"visualClear\"></div>\n" .
650 return $this->
getInfoBox( $text,
'critical-32.png',
'config-error-box' );
661 return $this->
getInfoBox( $text,
'warning-32.png',
'config-warning-box' );
673 public function getInfoBox( $text, $icon =
false, $class =
false ) {
674 $text = $this->
parse( $text,
true );
675 $icon = ( $icon ==
false ) ?
676 'images/info-32.png' :
678 $alt =
wfMessage(
'config-information' )->text();
691 $args = func_get_args();
692 array_shift(
$args );
693 $args = array_map(
'htmlspecialchars',
$args );
697 return "<div class=\"config-help-field-container\">\n" .
698 "<span class=\"config-help-field-hint\" title=\"" .
699 wfMessage(
'config-help-tooltip' )->escaped() .
"\">" .
700 wfMessage(
'config-help' )->escaped() .
"</span>\n" .
701 "<div class=\"config-help-field-data\">" .
$html .
"</div>\n" .
710 $args = func_get_args();
722 $args = func_get_args();
723 array_shift(
$args );
724 $html =
'<div class="config-message">' .
734 $errors = array_merge(
$status->getErrorsArray(),
$status->getWarningsArray() );
735 foreach ( $errors
as $error ) {
750 public function label( $msg, $forId, $contents, $helpData =
"" ) {
751 if ( strval( $msg ) ==
'' ) {
752 $labelText =
"\u{00A0}";
754 $labelText =
wfMessage( $msg )->escaped();
757 $attributes = [
'class' =>
'config-label' ];
760 $attributes[
'for'] = $forId;
763 return "<div class=\"config-block\">\n" .
764 " <div class=\"config-block-label\">\n" .
771 " <div class=\"config-block-elements\">\n" .
792 if ( !isset(
$params[
'controlName'] ) ) {
796 if ( !isset(
$params[
'value'] ) ) {
800 if ( !isset(
$params[
'attribs'] ) ) {
803 if ( !isset(
$params[
'help'] ) ) {
815 'id' =>
$params[
'controlName'],
816 'class' =>
'config-input-text',
839 if ( !isset(
$params[
'controlName'] ) ) {
843 if ( !isset(
$params[
'value'] ) ) {
847 if ( !isset(
$params[
'attribs'] ) ) {
850 if ( !isset(
$params[
'help'] ) ) {
863 'id' =>
$params[
'controlName'],
864 'class' =>
'config-input-text',
888 if ( !isset(
$params[
'value'] ) ) {
892 if ( !isset(
$params[
'attribs'] ) ) {
897 $params[
'attribs'][
'type'] =
'password';
918 if ( !isset(
$params[
'controlName'] ) ) {
922 if ( !isset(
$params[
'value'] ) ) {
926 if ( !isset(
$params[
'attribs'] ) ) {
929 if ( !isset(
$params[
'help'] ) ) {
932 if ( !isset(
$params[
'labelAttribs'] ) ) {
935 if ( isset(
$params[
'rawtext'] ) ) {
936 $labelText =
$params[
'rawtext'];
941 return "<div class=\"config-input-check\">\n" .
950 'id' =>
$params[
'controlName'],
981 if ( !isset(
$params[
'label'] ) ) {
987 if ( !isset(
$params[
'controlName'] ) ) {
991 if ( !isset(
$params[
'help'] ) ) {
996 foreach ( $items
as $value => $item ) {
997 $s .=
"<li>$item</li>\n";
1013 if ( !isset(
$params[
'controlName'] ) ) {
1017 if ( !isset(
$params[
'value'] ) ) {
1026 if ( isset(
$params[
'commonAttribs'] ) ) {
1027 $itemAttribs =
$params[
'commonAttribs'];
1031 $itemAttribs =
$params[
'itemAttribs'][
$value] + $itemAttribs;
1036 $itemAttribs[
'id'] = $id;
1043 isset(
$params[
'itemLabels'] ) ?
1059 $text =
$status->getWikiText();
1067 $this->
output->addHTML( $box );
1084 foreach ( $varNames
as $name ) {
1087 if ( stripos(
$name,
'password' ) ===
false ) {
1094 $this->
setVar( $name,
false );
1096 if ( stripos(
$name,
'password' ) !==
false ) {
1115 $query = [
'page' => $page ];
1117 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1150 [
'href' => $this->
getUrl( [
'localsettings' => 1 ] ) ],
1154 return Html::rawElement(
'div', [
'class' =>
'config-download-link' ], $anchor );
1179 if ( !empty( $_SERVER[
'PHP_SELF'] ) ) {
1180 $path = $_SERVER[
'PHP_SELF'];
1181 } elseif ( !empty( $_SERVER[
'SCRIPT_NAME'] ) ) {
1182 $path = $_SERVER[
'SCRIPT_NAME'];
1184 if (
$path ===
false ) {
1189 return parent::envCheckPath();
1193 parent::envPrepPath();
1198 if ( !empty( $_SERVER[
'PHP_SELF'] ) ) {
1199 $path = $_SERVER[
'PHP_SELF'];
1200 } elseif ( !empty( $_SERVER[
'SCRIPT_NAME'] ) ) {
1201 $path = $_SERVER[
'SCRIPT_NAME'];
1203 if (
$path !==
false ) {
1204 $scriptPath = preg_replace(
'{^(.*)/(mw-)?config.*$}',
'$1',
$path );
1206 $this->
setVar(
'wgScriptPath',
"$scriptPath" );
1208 $this->
setVar(
'wgScript',
"$scriptPath/index.php" );
1209 $this->
setVar(
'wgLoadScript',
"$scriptPath/load.php" );
1210 $this->
setVar(
'wgStylePath',
"$scriptPath/skins" );
1211 $this->
setVar(
'wgLocalStylePath',
"$scriptPath/skins" );
1212 $this->
setVar(
'wgExtensionAssetsPath',
"$scriptPath/extensions" );
1213 $this->
setVar(
'wgUploadPath',
"$scriptPath/images" );
1214 $this->
setVar(
'wgResourceBasePath',
"$scriptPath" );
1231 $this->
request->response()->header(
'Content-type: application/x-httpd-php' );
1232 $this->
request->response()->header(
1233 'Content-Disposition: attachment; filename="LocalSettings.php"'
1237 $rightsProfile = $this->rightsProfiles[$this->
getVar(
'_RightsProfile' )];
1238 foreach ( $rightsProfile
as $group => $rightsArr ) {
1239 $ls->setGroupRights( $group, $rightsArr );
1241 echo $ls->getText();
1248 $this->
request->response()->header(
'Content-type: text/css' );
1249 echo $this->
output->getCSS();
getAcceptLanguage()
Retrieves MediaWiki language from Accept-Language HTTP header.
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
processing should stop and the error should be shown to the user * false
getHelpBox( $msg)
Get small text indented help for a preceding form field.
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
startPageWrapper( $currentPageName)
Called by execute() before page output starts, to show a page list.
if(!isset( $args[0])) $lang
getRadioElements( $params)
Get a set of labelled radio buttons.
label( $msg, $forId, $contents, $helpData="")
Label a control by wrapping a config-input div around it and putting a label before it.
getPageListItem( $pageName, $enabled, $currentPageName)
Get a list item for the page list.
startSession()
Start the PHP session.
bool $showSessionWarning
Flag indicating that session data may have been lost.
showStatusMessage(Status $status)
string[] $pageSequence
The main sequence of page names.
array[] $session
Cached session array.
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. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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
setupLanguage()
Initializes language-related variables.
getCheckBox( $params)
Get a labelled checkbox to configure a boolean variable.
Class for the core installer web interface.
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
getWarningBox( $text)
Get HTML for a warning box with an icon.
int $tabIndex
Numeric index of the page we're on.
showHelpBox( $msg)
Output a help box.
getPageByName( $pageName)
Get a WebInstallerPage by name.
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
__construct(WebRequest $request)
bool[] $happyPages
Array of pages which have declared that they have been submitted, have validated their input,...
showStatusBox( $status)
Output an error or warning box using a Status object.
getLowestUnhappy()
Find the next page in sequence that hasn't been completed.
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
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
getInfoBox( $text, $icon=false, $class=false)
Get HTML for an info box with an icon.
Output class modelled on OutputPage.
WebInstallerOutput $output
Generic operation result class Has warning/error list, boolean status and arbitrary value.
getRadioSet( $params)
Get a set of labelled radio buttons.
showMessage( $msg)
Show a short informational message.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
null for the 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
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
getTextArea( $params)
Get a labelled textarea to configure a variable.
setSession( $name, $value)
Set a session variable.
WebRequest $request
WebRequest object.
execute(array $session)
Main entry point.
nextTabIndex()
Get the next tabindex attribute value.
bool[] $skippedPages
List of "skipped" pages.
errorHandler( $errno, $errstr)
Temporary error handler for session start debugging.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
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
getFingerprint()
Get a hash of data identifying this MW installation.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment this hook should only be used to add variables that depend on the current page request
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
outputLS()
Actually output LocalSettings.php for download.
downloadLinkHook( $text, $attribs, $parser)
Helper for "Download LocalSettings" link on WebInstall_Complete.
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
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
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))
string[] $phpErrors
Captured PHP error text.
static infoBox( $text, $icon, $alt, $class='')
Get HTML for an info box with an icon.
Allows to change the fields on the form that will be generated $name
string[] $otherPages
Out of sequence pages, selectable by the user at any time.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
string $currentPageName
Name of the page we're on.
getPasswordBox( $params)
Get a labelled password box to configure a variable.
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
$wgLanguageCode
Site language code.
reset()
We're restarting the installation, reset the session, happyPages, etc.
setVarsFromRequest( $varNames, $prefix='config_')
Convenience function to set variables based on form data.
outputCss()
Output stylesheet for web installer pages.
static getMain()
Get the RequestContext object associated with the main request.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
endPageWrapper()
Output some stuff after a page is finished.
showError( $msg)
Show an error message in a box.
getLocalSettingsLocation()
If the software package wants the LocalSettings.php file to be placed in a specific location,...
getErrorBox( $text)
Get HTML for an error box with an icon.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
docLink( $linkText, $attribs, $parser)
Extension tag hook for a documentation link.
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
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
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
getDocUrl( $page)
Helper for Installer::docLink()
static detectServer()
Work out an appropriate URL prefix containing scheme and host, based on information detected from $_S...
disableTimeLimit()
Disable the time limit for execution.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
getTextBox( $params)
Get a labelled text box to configure a variable.
static factory( $code)
Get a cached or new language object for a given language code.
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
if(! $wgDBerrorLogTZ) $wgRequest
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
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
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
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 "<
getSession( $name, $default=null)
Get a session variable.
finish()
Clean up from execute()
getUrl( $query=[])
Get a URL for submission back to the same script.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....