includes/config/Config.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  * Abstract class for get settings for
  25  *
  26  * @since 1.23
  27  */
  28
  29 abstract class Config {
  30
  31         /**
  32          * @param string $name configuration variable name without prefix
  33          * @param string $prefix of the variable name
  34          * @return mixed
  35          */
  36         abstract public function get( $name, $prefix = 'wg' );
  37
  38         /**
  39          * @param string $name configuration variable name without prefix
  40          * @param mixed $value to set
  41          * @param string $prefix of the variable name
  42          * @return Status object indicating success or failure
  43          */
  44         abstract public function set( $name, $value, $prefix = 'wg' );
  45
  46         /**
  47          * @param string|null $type class name for Config object,
  48          *        uses $wgConfigClass if not provided
  49          * @return Config
  50          */
  51         public static function factory( $type = null ) {
  52                 if ( !$type ) {
  53                         global $wgConfigClass;
  54                         $type = $wgConfigClass;
  55                 }
  56
  57                 return new $type;
  58         }
  59 }