Go to the documentation of this file.
31 private $specifiedScriptPath =
false;
33 private $optionMap = [
34 'dbtype' =>
'wgDBtype',
35 'dbserver' =>
'wgDBserver',
36 'dbname' =>
'wgDBname',
37 'dbuser' =>
'wgDBuser',
38 'dbpass' =>
'wgDBpassword',
39 'dbprefix' =>
'wgDBprefix',
40 'dbtableoptions' =>
'wgDBTableOptions',
41 'dbmysql5' =>
'wgDBmysql5',
42 'dbport' =>
'wgDBport',
43 'dbschema' =>
'wgDBmwschema',
44 'dbpath' =>
'wgSQLiteDataDir',
45 'server' =>
'wgServer',
46 'scriptpath' =>
'wgScriptPath',
59 parent::__construct();
61 if ( isset( $option[
'scriptpath'] ) ) {
62 $this->specifiedScriptPath =
true;
65 foreach ( $this->optionMap
as $opt => $global ) {
66 if ( isset( $option[
$opt] ) ) {
72 if ( isset( $option[
'lang'] ) ) {
74 $this->
setVar(
'_UserLang', $option[
'lang'] );
81 $this->
setVar(
'wgSitename', $siteName );
83 $metaNS =
$wgContLang->ucfirst( str_replace(
' ',
'_', $siteName ) );
84 if ( $metaNS ==
'MediaWiki' ) {
87 $this->
setVar(
'wgMetaNamespace', $metaNS );
90 $this->
setVar(
'_AdminName', $admin );
93 if ( !isset( $option[
'installdbuser'] ) ) {
94 $this->
setVar(
'_InstallUser',
95 $this->
getVar(
'wgDBuser' ) );
96 $this->
setVar(
'_InstallPassword',
97 $this->
getVar(
'wgDBpassword' ) );
99 $this->
setVar(
'_InstallUser',
100 $option[
'installdbuser'] );
101 $this->
setVar(
'_InstallPassword',
102 isset( $option[
'installdbpass'] ) ? $option[
'installdbpass'] :
"" );
105 $this->
setVar(
'_CreateDBAccount',
true );
108 if ( isset( $option[
'pass'] ) ) {
109 $this->
setVar(
'_AdminPassword', $option[
'pass'] );
114 $this->
setVar(
'_Skins', $skins );
117 $skinNames = array_map(
'strtolower', $skins );
134 [ $this,
'startStage' ],
135 [ $this,
'endStage' ]
144 public function writeConfigurationFile(
$path ) {
146 $ls->writeFile(
"$path/LocalSettings.php" );
149 public function startStage( $step ) {
156 public function endStage( $step,
$status ) {
162 echo $this->getMessageText( func_get_args() ) .
"\n";
167 echo
"***{$this->getMessageText( func_get_args() )}***\n";
176 protected function getMessageText(
$params ) {
181 $text = preg_replace(
'/<a href="(.*?)".*?>(.*?)<\/a>/',
'$2 <$1>', $text );
183 return html_entity_decode( strip_tags( $text ), ENT_QUOTES );
189 public function showHelpBox( $msg ) {
193 $warnings = array_merge(
$status->getWarningsArray(),
196 if (
count( $warnings ) !== 0 ) {
197 foreach ( $warnings
as $w ) {
198 call_user_func_array( [ $this,
'showMessage' ], $w );
209 if ( !$this->specifiedScriptPath ) {
213 return parent::envCheckPath();
__construct()
Constructor, always call this from child classes.
showMessage( $msg)
UI interface for displaying a short message The parameters are like parameters to wfMessage().
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
dirIsExecutable( $dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
static newFatal( $message)
Factory function for fatal errors.
performInstallation( $startCB, $endCB)
Actually perform the installation.
envGetDefaultServer()
Helper function to be called from envPrepServer()
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.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
showError( $msg)
Same as showMessage(), but for displaying errors.
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
envCheckPath()
Environment check to inform user which paths we've assumed.
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
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
when a variable name is used in a it is silently declared as a new masking the global
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
$GLOBALS['wgAutoloadClasses']['LocalisationUpdate']
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,...
findExtensions( $directory='extensions')
Finds extensions that follow the format /$directory/Name/Name.php, and returns an array containing th...
$wgLanguageCode
Site language code.
static getMain()
Static methods.
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 factory( $code)
Get a cached or new language object for a given language 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 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 "<
the array() calling protocol came about after MediaWiki 1.4rc1.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang