includes/config/MultiConfig.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 namespace MediaWiki\Config;
  24
  25 /**
  26  * Provides a fallback sequence for Config objects
  27  *
  28  * @since 1.24
  29  */
  30 class MultiConfig implements Config {
  31
  32         /**
  33          * Array of Config objects to use
  34          * Order matters, the Config objects
  35          * will be checked in order to see
  36          * whether they have the requested setting
  37          *
  38          * @var Config[]
  39          */
  40         private $configs;
  41
  42         /**
  43          * @param Config[] $configs
  44          */
  45         public function __construct( array $configs ) {
  46                 $this->configs = $configs;
  47         }
  48
  49         /**
  50          * @inheritDoc
  51          */
  52         public function get( $name ) {
  53                 foreach ( $this->configs as $config ) {
  54                         if ( $config->has( $name ) ) {
  55                                 return $config->get( $name );
  56                         }
  57                 }
  58
  59                 throw new ConfigException( __METHOD__ . ": undefined option: '$name'" );
  60         }
  61
  62         /**
  63          * @inheritDoc
  64          */
  65         public function has( $name ) {
  66                 foreach ( $this->configs as $config ) {
  67                         if ( $config->has( $name ) ) {
  68                                 return true;
  69                         }
  70                 }
  71
  72                 return false;
  73         }
  74 }
  75
  76 /** @deprecated class alias since 1.41 */
  77 class_alias( MultiConfig::class, 'MultiConfig' );