User Contributed Preferences in Horde5

Perhaps the greatest feature of Horde and all of it's modules is the flexibility to adapt to a myriad of different uses and I would expect that eventually, a more integrated system of managing 'defaults' will become part of the code but at this moment in time, the only way to effect settings system wide is to edit the various prefs.php file inside each module.

In general: Add any local changes to a prefs.local.php or a prefs.d/<name>,php file. Never change prefs.php because this file is overwritten on upgrade and contains vital system information about the preferences that must match the other parts of the system. For instance,

kronolith/config/prefs.php contains:

<?php

// Address book(s) to use when expanding addresses ``
// Refer to turba/config/sources.php for possible source values
//
// You can provide default values this way:
//   'value' => json_encode(array('source_one', 'source_two'))
$_prefs['search_sources'] = array(
    'value' => ''
);
?>

To change the default value add the following PHP code to either kronolith/config/prefs.local.php or kronolith/config/prefs.d/name.php name can be any name you like, I prefer the local hostname:

<?php

<?PHP
$_prefs['search_sources']['value'] = '["favourites"]';
?>

Hooks

You can provide default values by hooks, which are little PHP functions.

Since Horde4 hooks are organized in classes, e.g. config/hooks.php uses class Horde_Hooks, whereas kronolith/config/hooks.php uses class Kronolith_Hooks. See config/hooks.php for a description of hooks.

For instance to automatically prepare Kronolith's search_sources with all address books the user has access to:

Enable the hook in the local prefs.php kronolith/config/prefs.local.php:
<?PHP
$_prefs['search_sources']['hook'] = true;
</code>

And add to kronolith/config/hooks.php:

<?php

<?PHP
class Kronolith_Hooks
{
    public function prefs_init($pref, $value, $username, $scope_ob)
    {
            if (is_null($username)) {    // not logged in
                return $value;
            }

        switch ($pref) {
         case 'search_sources':    // enable all sources by default
            if($value == '') {
            $sources = $GLOBALS['registry']->call('contacts/sources');
            $value = json_encode(array_keys($sources));
            $scope_ob->set($pref, $value);
            $scope_ob->setDirty($pref, true);
            }
        return $value;
     }
    }
}
?>

Because the prefs_init hook is called each time an user logins, line 12 shall prevent that the value is set to default each time, probably overwriting the user's choice. The empty string is the default value of the search_sources.

Line 13 collects all address books from Turba, the user has access to. Line 14 prepares the string for the preference. These lines are very preference-specific.

Line 15 and 16 permanently write the settings into the preference storage of the user. The next time the user logins, $value is no longer empty, hence, the if() block is skipped and any newly available address books are not automatically enabled. If you want to keep the preference unchanged once the user has change the setting manually, remove these two lines.