Adding module configuration settings to config.php

Question

As here, I'm looking to set some variables for a module. Creating a DB table seems a bit overkill (or maybe it's really not). I've noticed that the Simple Commerce Module does two things: creates DB tables and adds to the config.php file. With the second method, it's using ee()->config->_update_config.

I cannot find any documentation on _update_config. It seems straight-forward enough, but I'm wondering if there's a reason I shouldn't use it.

In short, I'm looking to package a module for distribution, and I don't want to make it more complicated than it needs to be (e.g., I don't want to have to install an extension and a module). Is adding variable/settings to config.php a good idea?

Answer 1

I would store the settings in 'settings' column in 'exp_modules' table.

It does not exist in early versions of EE 2.x, so in your upd.my_module.php in function install() add

    $this->EE->load->dbforge(); 

    //----------------------------------------
    // EXP_MODULES
    // The settings column, Ellislab should have put this one in long ago.
    // No need for a seperate preferences table for each module.
    //----------------------------------------
    if ($this->EE->db->field_exists('settings', 'modules') == FALSE)
    {
        $this->EE->dbforge->add_column('modules', array('settings' => array('type' => 'TEXT') ) );
    }

and example save_settings() function can look like this

function save_settings()
{

    if (empty($_POST))
    {
        show_error($this->EE->lang->line('unauthorized_access'));
    }

    unset($_POST['submit']);

    $this->EE->db->where('module_name', 'My_module');
    $this->EE->db->update('modules', array('settings' => serialize($_POST)));

    $this->EE->session->set_flashdata(
        'message_success',
        $this->EE->lang->line('preferences_updated')
    );

    $this->EE->functions->redirect(BASE.AMP.'C=addons_modules'.AMP.'M=show_module_cp'.AMP.'module=my_module'.AMP.'method=settings');
}

Answer 2

You could try:

master config where you can set environment variables and custom global variables but this isnt done via control panel. In fact, quite the opposite happens. You set a variable in master config and it cant be changed in control panel. Handy when you have certain settings that need to be locked down.

stash and set user or site variables via an input form. Save variable and define an appropriate refresh period.