icingaweb2/library/Icinga/Config/Config.php

<?php
// {{{ICINGA_LICENSE_HEADER}}}
/**
 * This file is part of Icinga 2 Web.
 * 
 * Icinga 2 Web - Head for multiple monitoring backends.
 * Copyright (C) 2013 Icinga Development Team
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * 
 * @copyright 2013 Icinga Development Team <info@icinga.org>
 * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
 * @author    Icinga Development Team <info@icinga.org>
 */
// {{{ICINGA_LICENSE_HEADER}}}

namespace Icinga\Config;

use Zend_Config_Ini;

/**
 * Global registry of application and module configuration.
 */
class Config extends Zend_Config_Ini
{
    /**
     * Configuration directory where ALL (application and module) configuration is located
     * @var string
     */
    public static $configDir;

    /**
     * The INI file this configuration has been loaded from
     * @var string
     */
    protected $configFile;

    /**
     * Application config instances per file
     * @var array
     */
    protected static $app = array();

    /**
     * Module config instances per file
     * @var array
     */
    protected static $modules = array();

    /**
     * Load configuration from the config file $filename
     *
     * @see     Zend_Config_Ini::__construct
     *
     * @param   string      $filename
     * @throws  Exception
     */
    public function __construct($filename)
    {
        if (!@is_readable($filename)) {
            throw new \Exception('Cannot read config file: ' . $filename);
        };
        $this->configFile = $filename;
        $section = null;
        $options = array(
            'allowModifications' => true
        );
        parent::__construct($filename, $section, $options);
    }

    /**
     * Retrieve a application config instance
     *
     * @param   string  $configname
     * @return  mixed
     */
    public static function app($configname = 'config')
    {
        if (!isset(self::$app[$configname])) {
            $filename = self::$configDir . '/' . $configname . '.ini';
            self::$app[$configname] = new Config(realpath($filename));
        }
        return self::$app[$configname];
    }

    /**
     * Retrieve a module config instance
     *
     * @param   string  $modulename
     * @param   string  $configname
     * @return  Config
     */
    public static function module($modulename, $configname = 'config')
    {
        if (!isset(self::$modules[$modulename])) {
            self::$modules[$modulename] = array();
        }
        $moduleConfigs = self::$modules[$modulename];
        if (!isset($moduleConfigs[$configname])) {
            $filename = self::$configDir . '/modules/' . $modulename . '/' . $configname . '.ini';
            if (file_exists($filename)) {
                $moduleConfigs[$configname] = new Config(realpath($filename));
            } else {
                $moduleConfigs[$configname] = null;
            }
        }
        return $moduleConfigs[$configname];
    }

    /**
     * Retrieve names of accessible sections or properties
     *
     * @param   $name
     * @return  array
     */
    public function keys($name = null)
    {
        if ($name === null) {
            return array_keys($this->toArray());
        } elseif ($this->$name === null) {
            return array();
        } else {
            return array_keys($this->$name->toArray());
        }
    }
}