File/program/lib/configurationmanagerlib.php

Description

/program/lib/configurationmanagerlib.php - configurationmanager

  • author: Peter Fokker <peter@berestijn.nl>
  • version: $Id: configurationmanagerlib.php,v 1.10 2016/04/26 09:33:19 peter Exp $
  • copyright: Copyright (C) 2008-2016 Ingenieursbureau PSD/Peter Fokker
  • license: GNU AGPLv3+Additional Terms
Constants
CHORE_SAVE = save (line 34)
TASK_ALERTS = alerts (line 32)
TASK_AREAS = areas (line 30)
TASK_CONFIGURATION_INTRO = intro (line 29)
TASK_SITE = site (line 31)
Functions
job_configurationmanager (line 46)

main entry point for configurationmanager (called from /program/main_admin.php)

this routine dispatches the tasks, If the specified task is not recognised, the default task TASK_CONFIGURATION_INTRO is executed.

  • return: results are returned as output in $output
void job_configurationmanager (object &$output)
  • object &$output: collects the html output
process_task_site (line 167)

handle the editing/saving of the main configuration information

this routine handles editing of the main configuration parameters. It either displays the edit dialog or saves the modified data and shows the configuration manager introduction screen.

Note that we do NOT try to redirect the user via a header() after a succesful save. It would be handy because this particular save action may have had impact on the global configuration, which is already read at this point. By redirecting we would make a fresh start, with the new parameters. However, we lose the easy ability to tell the user that the data was saved (via $output->add_message()). So, either no feedback or obsolete global config in core. Hmmmm. I settle for the feedback and the 'wrong' settings.

  • return: results are returned as output in $output
  • uses: ConfigAssistant()
void process_task_site (object &$output)
  • object &$output: collects the html output
show_configuration_intro (line 102)

display an introductory text for the configuration manager + menu

  • return: results are returned as output in $output
void show_configuration_intro (object &$output)
  • object &$output: collects the html output
show_configuration_menu (line 114)

display the configuration manager menu

  • return: results are returned as output in $output
void show_configuration_menu (object &$output, [string $current_task = NULL])
  • object &$output: collects the html output
  • string $current_task: indicate the current menu selection (if any)

Documentation generated on Tue, 28 Jun 2016 19:08:48 +0200 by phpDocumentor 1.4.0