From 5f80860c5a77af1a1cb12ce44c392a1127b28f90 Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Thu, 26 May 2011 11:37:19 -0400
Subject: [PATCH] Added information about the system config system to the coding notes file.
---
CODING_NOTES.php.txt | 29 +++++++++++++++++++++++++++++
1 files changed, 29 insertions(+), 0 deletions(-)
diff --git a/CODING_NOTES.php.txt b/CODING_NOTES.php.txt
index ca3cf78..da9f2db 100644
--- a/CODING_NOTES.php.txt
+++ b/CODING_NOTES.php.txt
@@ -92,5 +92,34 @@
... do something interesting
}
+//*****************************************************************************
+// Where to store custom settings
+//*****************************************************************************
+
+-- Interface settings
+
+The recommended place to store global interface settings is the ini style global config system
+(see system.ini.master file in install/tpl/ to set defaults). The settings file
+gets stored inside the ispconfig database. Settings can be accessed with the function:
+
+$app->uses('ini_parser,getconf');
+$interface_settings = $app->getconf->get_global_config('modulename');
+
+where modulename corresponds to the config section in the system.ini.master file.
+To make the settings editable under System > interface config, add the new configuration
+fields to the file interface/web/admin/form/system_config.tform.php and the corresponding
+tempalte file in the templates subfolder of the admin module.
+
+-- Server settings
+
+Server settings are stored in the ini style server config system (see server.ini.master template file)
+The settings file gets stored inside the ispconfig database in the server table. Settings can be
+accessed with the function $app->getconf->get_server_config(....)
+
+Example to access the web configuration:
+
+$app->uses('ini_parser,getconf');
+$web_config = $app->getconf->get_server_config($server_id,'web');
+
--
Gitblit v1.9.1