*
* @code
* $conf = new SiteConfiguration;
- * $conf->wikis = array( 'de', 'en', 'beta' );
+ * $conf->wikis = [ 'de', 'en', 'beta' ];
* @endcode
*
* When configuring the MediaWiki global settings (the $wg variables),
* the identifiers will be available to specify settings on a per wiki basis.
*
* @code
- * $conf->settings = array(
- * 'wgSomeSetting' => array(
+ * $conf->settings = [
+ * 'wgSomeSetting' => [
*
* # production:
* 'de' => false,
*
* # test:
* 'beta => true,
- * ),
- * );
+ * ],
+ * ];
* @endcode
*
* With three wikis, that is easy to manage. But what about a farm with
* the above code could be written:
*
* @code
- * $conf->settings = array(
- * 'wgSomeSetting' => array(
+ * $conf->settings = [
+ * 'wgSomeSetting' => [
*
* 'default' => false,
*
* # Enable feature on test
* 'beta' => true,
- * ),
- * );
+ * ],
+ * ];
* @endcode
*
*
* on a per wiki basis.
*
* @code
- * $conf->settings = array(
- * 'wgMergeSetting' = array(
+ * $conf->settings = [
+ * 'wgMergeSetting' = [
* # Value that will be shared among all wikis:
- * 'default' => array( NS_USER => true ),
+ * 'default' => [ NS_USER => true ],
*
* # Leading '+' means merging the array of value with the defaults
- * '+beta' => array( NS_HELP => true ),
- * ),
- * );
+ * '+beta' => [ NS_HELP => true ],
+ * ],
+ * ];
*
* # Get configuration for the German site:
* $conf->get( 'wgMergeSetting', 'de' );
- * // --> array( NS_USER => true );
+ * // --> [ NS_USER => true ];
*
* # Get configuration for the testing site:
* $conf->get( 'wgMergeSetting', 'beta' );
- * // --> array( NS_USER => true, NS_HELP => true );
+ * // --> [ NS_USER => true, NS_HELP => true ];
* @endcode
*
* Finally, to load all configuration settings, extract them in global context:
* extract( $globals );
* @endcode
*
+ * @note For WikiMap to function, the configuration must define string values for
+ * $wgServer (or $wgCanonicalServer) and $wgArticlePath, even if these are the
+ * same for all wikis or can be correctly determined by the logic in
+ * Setup.php.
+ *
* @todo Give examples for,
* suffixes:
- * $conf->suffixes = array( 'wiki' );
+ * $conf->suffixes = [ 'wiki' ];
* localVHosts
* callbacks!
*/
/**
* Array of suffixes, for self::siteFromDB()
*/
- public $suffixes = array();
+ public $suffixes = [];
/**
* Array of wikis, should be the same as $wgLocalDatabases
*/
- public $wikis = array();
+ public $wikis = [];
/**
* The whole array of settings
*/
- public $settings = array();
+ public $settings = [];
/**
* Array of domains that are local and can be handled by the same server
*
* @deprecated since 1.25; use $wgLocalVirtualHosts instead.
*/
- public $localVHosts = array();
+ public $localVHosts = [];
/**
* Optional callback to load full configuration data.
* Configuration cache for getConfig()
* @var array
*/
- protected $cfgCache = array();
+ protected $cfgCache = [];
/**
* Retrieves a configuration setting for a given wiki.
* @param array $wikiTags The tags assigned to the wiki.
* @return mixed The value of the setting requested.
*/
- public function get( $settingName, $wiki, $suffix = null, $params = array(),
- $wikiTags = array()
+ public function get( $settingName, $wiki, $suffix = null, $params = [],
+ $wikiTags = []
) {
$params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
return $this->getSetting( $settingName, $wiki, $params );
break 2;
} elseif ( array_key_exists( "+$tag", $thisSetting ) && is_array( $thisSetting["+$tag"] ) ) {
if ( $retval === null ) {
- $retval = array();
+ $retval = [];
}
$retval = self::arrayMerge( $retval, $thisSetting["+$tag"] );
}
&& is_array( $thisSetting["+$suffix"] )
) {
if ( $retval === null ) {
- $retval = array();
+ $retval = [];
}
$retval = self::arrayMerge( $retval, $thisSetting["+$suffix"] );
}
* @param array $wikiTags The tags assigned to the wiki.
* @return array Array of settings requested.
*/
- public function getAll( $wiki, $suffix = null, $params = array(), $wikiTags = array() ) {
+ public function getAll( $wiki, $suffix = null, $params = [], $wikiTags = [] ) {
$params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
- $localSettings = array();
+ $localSettings = [];
foreach ( $this->settings as $varname => $stuff ) {
$append = false;
$var = $varname;
* @param array $wikiTags The tags assigned to the wiki.
* @return bool The value of the setting requested.
*/
- public function getBool( $setting, $wiki, $suffix = null, $wikiTags = array() ) {
- return (bool)$this->get( $setting, $wiki, $suffix, array(), $wikiTags );
+ public function getBool( $setting, $wiki, $suffix = null, $wikiTags = [] ) {
+ return (bool)$this->get( $setting, $wiki, $suffix, [], $wikiTags );
}
/**
* @param array $wikiTags The tags assigned to the wiki.
*/
public function extractVar( $setting, $wiki, $suffix, &$var,
- $params = array(), $wikiTags = array()
+ $params = [], $wikiTags = []
) {
$value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags );
if ( !is_null( $value ) ) {
* @param array $wikiTags The tags assigned to the wiki.
*/
public function extractGlobal( $setting, $wiki, $suffix = null,
- $params = array(), $wikiTags = array()
+ $params = [], $wikiTags = []
) {
$params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
$this->extractGlobalSetting( $setting, $wiki, $params );
* @param array $params List of parameters. $.'key' is replaced by $value in all returned data.
* @param array $wikiTags The tags assigned to the wiki.
*/
- public function extractAllGlobals( $wiki, $suffix = null, $params = array(),
- $wikiTags = array()
+ public function extractAllGlobals( $wiki, $suffix = null, $params = [],
+ $wikiTags = []
) {
$params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
foreach ( $this->settings as $varName => $setting ) {
* @return array
*/
protected function getWikiParams( $wiki ) {
- static $default = array(
+ static $default = [
'suffix' => null,
'lang' => null,
- 'tags' => array(),
- 'params' => array(),
- );
+ 'tags' => [],
+ 'params' => [],
+ ];
if ( !is_callable( $this->siteParamsCallback ) ) {
return $default;
}
- $ret = call_user_func_array( $this->siteParamsCallback, array( $this, $wiki ) );
+ $ret = call_user_func_array( $this->siteParamsCallback, [ $this, $wiki ] );
# Validate the returned value
if ( !is_array( $ret ) ) {
return $default;
// Allow override
$def = $this->getWikiParams( $db );
if ( !is_null( $def['suffix'] ) && !is_null( $def['lang'] ) ) {
- return array( $def['suffix'], $def['lang'] );
+ return [ $def['suffix'], $def['lang'] ];
}
$site = null;
}
}
$lang = str_replace( '_', '-', $lang );
- return array( $site, $lang );
+ return [ $site, $lang ];
}
/**
$multi = is_array( $settings );
$settings = (array)$settings;
if ( $wiki === wfWikiID() ) { // $wiki is this wiki
- $res = array();
+ $res = [];
foreach ( $settings as $name ) {
if ( !preg_match( '/^wg[A-Z]/', $name ) ) {
throw new MWException( "Variable '$name' does start with 'wg'." );
} elseif ( !in_array( $wiki, $this->wikis ) ) {
throw new MWException( "No such wiki '$wiki'." );
} else {
- $this->cfgCache[$wiki] = array();
+ $this->cfgCache[$wiki] = [];
}
$retVal = 1;
$cmd = wfShellWikiCmd(
"$IP/maintenance/getConfiguration.php",
- array(
+ [
'--wiki', $wiki,
'--settings', implode( ' ', $settings ),
'--format', 'PHP'
- )
+ ]
);
// ulimit5.sh breaks this call
- $data = trim( wfShellExec( $cmd, $retVal, array(), array( 'memory' => 0 ) ) );
+ $data = trim( wfShellExec( $cmd, $retVal, [], [ 'memory' => 0 ] ) );
if ( $retVal != 0 || !strlen( $data ) ) {
throw new MWException( "Failed to run getConfiguration.php." );
}
return $multi ? $res : current( $res );
}
- /**
- * Returns true if the given vhost is handled locally.
- *
- * @deprecated since 1.25; check if the host is in $wgLocalVirtualHosts instead.
- * @param string $vhost
- * @return bool
- */
- public function isLocalVHost( $vhost ) {
- return in_array( $vhost, $this->localVHosts );
- }
-
/**
* Merge multiple arrays together.
* On encountering duplicate keys, merge the two, but ONLY if they're arrays.
dépôts / lhc / web / wiklou.git / blobdiff