File phpboost/config/ModulesConfig.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 

<?php
/**
 * This class contains the cache data of the modules which module users having common criteria.
 * @package     PHPBoost
 * @subpackage  Config
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Loic ROUCHON <horn@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2016 06 21
 * @since       PHPBoost 3.0 - 2009 12 12
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
*/

class ModulesConfig extends AbstractConfigData
{
    private static $modules_property = 'modules';

    /**
     * {@inheritdoc}
     */
    public function get_default_values()
    {
        return array(
            self::$modules_property => array()
        );
    }

    /**
     * Returns the list of the modules
     * @return array id_module => module properties (map)
     */
    public function get_modules()
    {
        return $this->get_property(self::$modules_property);
    }

    /**
     * Returns the requested module
     * @param $module_id the id of the module
     * @return Module the requested module
     */
    public function get_module($module_id)
    {
        $modules = $this->get_property(self::$modules_property);
        return isset($modules[$module_id]) ? $modules[$module_id] : null;
    }

    /**
     * Sets the modules list
     * @param Module[string] $modules_list The modules list
     */
    public function set_modules(array $modules)
    {
        $this->set_property(self::$modules_property, $modules);
    }

    /**
     * Install a new module
     * @param Module $modules The module to add (~ install)
     */
    public function add_module(Module $module)
    {
        $modules = $this->get_property(self::$modules_property);
        $modules[$module->get_id()] = $module;
        $this->set_property(self::$modules_property, $modules);
    }

    public function remove_module(Module $module)
    {
        $modules = $this->get_property(self::$modules_property);
        unset($modules[$module->get_id()]);
        $this->set_property(self::$modules_property, $modules);
    }

    public function remove_module_by_id($module_id)
    {
        $modules = $this->get_property(self::$modules_property);
        unset($modules[$module_id]);
        $this->set_property(self::$modules_property, $modules);
    }

    public function update(Module $module)
    {
        $modules = $this->get_property(self::$modules_property);
        $modules[$module->get_id()] = $module;

        $this->set_property(self::$modules_property, $modules);
    }

    /**
     * Loads and returns the modules cached data.
     * @return ModulesConfig The cached data
     */
    public static function load()
    {
        return ConfigManager::load(__CLASS__, 'kernel', 'modules');
    }

    /**
     * Invalidates the current modules cached data.
     */
    public static function save()
    {
        ConfigManager::save('kernel', self::load(), 'modules');
    }
}
?>