Open main menu

Manual:$wgConf

This page is a translated version of the page Manual:$wgConf and the translation is 90% complete.
Other languages:
English • ‎español • ‎français • ‎magyar • ‎polski • ‎português do Brasil • ‎中文 • ‎日本語 • ‎한국어
グローバル オブジェクト: $wgConf
サイト設定のオブジェクトを作成します。初期設定のままインストールする場合はほとんど使われません。
導入されたバージョン:1.5.0 (r9670)
除去されたバージョン:使用中
許容される値:未指定
既定値:new SiteConfiguration object.

詳細

サイト設定のオブジェクトを作成します。初期設定のままインストールする場合はほとんど使われません。

この設定はWikimediaの大規模インストールを行う際、数百のウィキに対する設定を集約するのに用いられるもので、サイトグループごとの初期値を設定し、ウィキごとに設定を上書きできるようにします。

しかし、少しややこしいかもしれません。 :) 今のところ、Extension:CentralAuthがサイトごとの情報(例:各ウィキの適切なユーザページへのリンク)を得るのに必要です。

設定

ウィキはデータベース名に接尾辞をつけてグループ分けされています。大規模インストールでは例えば 'enwiki'、'enwiktionary'、'enwikibooks'のようになり、それぞれが異なる接尾辞グループになります。$wgConf->siteFromDB()を使う場合、接尾辞は$wgConfのsuffixesメンバー変数で宣言する必要があります。

$wgConf->settingsは設定値群を格納している配列です。書式は$wgConf->settings['wgSettingName']['wiki']です。
設定は以下の対象に対する指定となります(範囲の狭い設定から範囲の広い設定への順、これは上記$wgConf->settingsのうち'wiki'の部分になります):

  • 特定のデータベース名
  • ウィキタグ(1.12.0から)
  • $wgConf->siteFromDB()によって決まる)接尾辞グループ内すべてに影響する接尾辞('wiki' や 'wiktionary' など)
  • すべてのウィキに影響する'初期値'

文字列設定のため、設定を抽出するときに置き換えられるパラメータを定義することができます。 すべてのウィキで書式を揃えておくと使いやすいでしょう。 $nameの書式で指定します。 シングルクォート(')を使うときや$をエスケープするとき(\$)は注意してください。さもないと(設定するときには値が決まらない)PHP変数に置換されてしまいます。

1.13以前

MediaWiki バージョン: 1.13

When extracting global settings, the object will search first the more specific level (the first one in the list above) and if it doesn't find the setting, it will search in less specific levels. When it finds one, if won't search for less specific ones. This means that you have to pay attention for some specific settings, such as $wgGroupPermissions , because it doesn't merge the setting with less specific levels, nor the default value (the one in DefaultSettings.php), you'll need to do it by yourself.

To extract the settings in global variables, you can use $wgConf->extractAllGlobals( $wiki, $suffix, $params, $wikiTags );.

Parameters are:

  • $wiki: Wiki's database name (generally $wgDBname ). You have to define it yourself.
  • $suffix: Wiki's suffix, used to to get the suffix level.
  • $params: array of parameters mapping its name to its value.
  • $wikiTags: (since 1.12.0) array of wiki tags.

1.14以降

MediaWiki バージョン: 1.14

1.14.0でいくつかの新機能が追加されました。1.13以前の部分も引き続き使えます。

コールバック関数

1.14より、コールバックが導入され、SiteConfiguration::get()やそれに関連する関数に渡すパラメータを調整できるようになりました。 パラメータの変更が使われるのは、そのような関数がLocalSettings.phpよりも後で呼び出されるときでしょう(CentralAuthがこのケースに該当します)。これは$wgConf->siteParamsCallbackで定義することができます。コールバック関数は最初の引数でサイト設定オブジェクトを、2つ目の引数でウィキ名を受け取ります。そして以下のキーを持つ配列を返します(いずれも必ずあるとは限らない)。

  • suffix: サイトの接尾辞(SiteConfiguration::get() およびこれに類似する $suffix パラメータ)
  • lang: サイトの言語
  • tags: ウィキタグの配列($wikiTags パラメータに関係)
  • params: 置き換えられるパラメータの配列($params パラメータに関係)

これらはパラメータに統合されSiteConfiguration::get()およびこれに似た関数に渡されます。suffixlang に値が設定されていた場合、既定の$wgConf->siteFromDB()の挙動を上書きするのに使われます。

設定の統合

配列はこれで統合できます。これは $wgGroupPermissions の設定に役立つでしょう。これを使うには統合しようとする設定のキーの前に"+"付け加えてください。

  • DefaultSettings.phpにある設定にカスタマイズした設定を統合するには、('+wgGroupPermissions'のように)設定名の前に"+"を付け加えてください
  • より限定した階層の設定を統合するには、その対象となる階層のキー名の前に"+"を付け加えてください。

両方を併用しても構いません。

統合は以下の順に行われます:

  1. データベース名
  2. タグ(抽出法による順序にて。これはこの点において非常によくランダム化されているでしょう)
  3. ウィキ接尾辞
  4. 既定値

"+"が前についていないキーがあったとき、統合は終了します。

$wgGroupPermissions に関する設定例:

$wgConf->settings = array(

// ...

// '+' triggers a merge with this and the value of $wgGroupPermissions defined
// in DefaultSettings.php
'+wgGroupPermissions' => array(

    // Allow bureaucrats to change status on remote wikis
    // and allow anonymous users to create page (this part
    // will not be merged with 'default' since there's no
    // "+" in front of 'centralwiki')
    'centralwiki' => array(
        'bureaucrat' => array(
            'userrights-interwiki' => true,
        ),
    ),

    // A wiki with rollback right given to logged-in users
    // the 'default' part will be merged with this value
    // (i.e. anonymous users won't be able to create pages)
    '+somewiki' => array(
        'user' => array(
            'rollback' => true,
        ),
    ),

    // Disallow anonymous users to create pages.
    // Note: the 'default' key should never have a "+" in front of it
    'default' => array(
        '*' => array(
            'createpage' => false,
            'createtalk' => false,
        ),
    ),
),

// ...

);

基本的な書式は以下の通りです:

$wgConf->settings=array(
'wgConfigurationSetting'=>array(
    'default'=>'defaultvalue',
    'wikidatabasename1'=>'value that overrides default for this wiki',
),
//To merge the settings you set here with those in DefaultSettings.php:
'+wgConfigurationSetting'=>array(
/*Note: This and DefaultSettings.php are NOT the same! The default specified here
        overrides that in DefaultSettings.php, and becomes the new default for all
        your wikis unless you choose to override it for a particular wiki,
        like for wikidatabasename1 here */
    'default'=>'defaultvalue',
    'wikidatabasename1'=>'value that overrides default for this wiki',
),
);

この例では3つのウィキ - dewiki, enwiki and frwiki - を使っています。これらはhttp://localhost/$wgDBname/にあります(つまり、http://localhost/dewiki/, http://localhost/enwiki/ and http://localhost/frwiki/)。

$wgDBname は既に定義されているものと仮定します。

この例において、$wgConf->settingsInitialiseSettings.phpで宣言されていますが、これは必ずしも必要ではなくLocalSettings.phpで宣言することもできます。

InitialiseSettings.php

<?php

$wgConf->settings = array(

'wgServer' => array(
    // if you want to allow also usage of https, just use '//localhost'
    // and set 'http://localhost' at 'wgCanonicalServer'
    'default' => 'http://localhost',
),

'wgCanonicalServer' => array(
    'default' => 'http://localhost',
),

'wgScriptPath' => array(
    'default' => '/$wiki',
),

'wgArticlePath' => array(
    'default' => '/$wiki/index.php/$1',
),

'wgSitename' => array(
    'default' => 'Wikipedia',
    'frwiki' => 'Wikipédia', // accent in French
),

'wgLanguageCode' => array(
    'default' => '$lang',
),

'wgLocalInterwiki' => array(
    'default' => '$lang',
),

);

LocalSettings.php

1.13以前

MediaWiki バージョン: 1.13


$wgLocalDatabases = array(
    'dewiki',
    'enwiki',
    'frwiki',
);

$wgConf->wikis = $wgLocalDatabases;
$wgConf->suffixes = array( 'wiki' );
$wgConf->localVHosts = array( 'localhost' );

require_once "$IP/InitialiseSettings.php";

list( $site, $lang ) = $wgConf->siteFromDB( $wgDBname );
$params = array(
    'site' => $site,
    'lang' => $lang,
    'wiki' => $wgDBname,
);
$wgConf->extractAllGlobals( $wgDBname, $site, $params, array() );

1.14以降

MediaWiki バージョン: 1.14


$wgLocalDatabases = array(
    'dewiki',
    'enwiki',
    'frwiki',
);

$wgConf->wikis = $wgLocalDatabases;
$wgConf->suffixes = array( 'wiki' );
$wgConf->localVHosts = array( 'localhost' );

require_once "$IP/InitialiseSettings.php";

function efGetSiteParams( $conf, $wiki ) {
    $site = null;
    $lang = null;
    foreach( $conf->suffixes as $suffix ) {
        if ( substr( $wiki, -strlen( $suffix ) ) == $suffix ) {
            $site = $suffix;
            $lang = substr( $wiki, 0, -strlen( $suffix ) );
            break;
        }
    }
    return array(
        'suffix' => $site,
        'lang' => $lang,
        'params' => array(
            'lang' => $lang,
            'site' => $site,
            'wiki' => $wiki,
        ),
        'tags' => array(),
    );
}

$wgConf->suffixes = $wgLocalDatabases;
$wgConf->siteParamsCallback = 'efGetSiteParams';
$wgConf->extractAllGlobals( $wgDBname );

ウィキメディアでの設定

ウィキメディアではどのように$wgConfを設定しウィキを設定しているのかについては以下を参照してください。

関連項目

  • includes/SiteConfiguration.php ファイルを見る(またはGitHubで見る)と、$wgConf がどのように機能するのかの案内があり、このページを見るよりも簡単に理解することができるでしょう。