includes/config/GlobalVarConfig.php

   1 <?php
   2 /**
   3  * Copyright 2014
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Accesses configuration settings from $GLOBALS
  25  *
  26  * @since 1.23
  27  */
  28 class GlobalVarConfig implements Config {
  29
  30         /**
  31          * Prefix to use for configuration variables
  32          * @var string
  33          */
  34         private $prefix;
  35
  36         /**
  37          * Default builder function
  38          * @return GlobalVarConfig
  39          */
  40         public static function newInstance() {
  41                 return new GlobalVarConfig();
  42         }
  43
  44         public function __construct( $prefix = 'wg' ) {
  45                 $this->prefix = $prefix;
  46         }
  47
  48         /**
  49          * @see Config::get
  50          */
  51         public function get( $name ) {
  52                 return $this->getWithPrefix( $this->prefix, $name );
  53         }
  54
  55         /**
  56          * @see MutableConfig::set
  57          * @deprecated since 1.24
  58          */
  59         public function set( $name, $value ) {
  60                 wfDeprecated( __METHOD__, '1.24' );
  61                 $this->setWithPrefix( $this->prefix, $name, $value );
  62         }
  63
  64         /**
  65          * Get a variable with a given prefix, if not the defaults.
  66          *
  67          * @param string $prefix Prefix to use on the variable, if one.
  68          * @param string $name Variable name without prefix
  69          * @throws ConfigException
  70          * @return mixed
  71          */
  72         protected function getWithPrefix( $prefix, $name ) {
  73                 $var = $prefix . $name;
  74                 if ( !array_key_exists( $var, $GLOBALS ) ) {
  75                         throw new ConfigException( __METHOD__ . ": undefined variable: '$var'" );
  76                 }
  77                 return $GLOBALS[$var];
  78         }
  79
  80         /**
  81          * Get a variable with a given prefix, if not the defaults.
  82          *
  83          * @param string $prefix Prefix to use on the variable
  84          * @param string $name Variable name without prefix
  85          * @param mixed $value Value to set
  86          * @deprecated since 1.24
  87          */
  88         protected function setWithPrefix( $prefix, $name, $value ) {
  89                 $GLOBALS[$prefix . $name] = $value;
  90         }
  91 }