From c84a6d596f48e03a9b258027cc2d7eea0049d12a Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Mon, 12 Sep 2011 09:56:08 -0400
Subject: [PATCH] Added: FS#1691 - Add support for mysql flags like MYSQL_CLIENT_SSL in ISPConfig mysql library
---
CODING_NOTES.php.txt | 34 ++++++++++++++++++++++++++++++++++
1 files changed, 34 insertions(+), 0 deletions(-)
diff --git a/CODING_NOTES.php.txt b/CODING_NOTES.php.txt
index ca3cf78..9b7ae8e 100644
--- a/CODING_NOTES.php.txt
+++ b/CODING_NOTES.php.txt
@@ -92,5 +92,39 @@
... 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');
+
+
+//*****************************************************************************
+// Learn about the form validators
+//*****************************************************************************
+There are form validators in interface/lib/classes/tform.inc.php to make validating forms easier.
+Read about: REGEX,UNIQUE,NOTEMPTY,ISEMAIL,ISINT,ISPOSITIVE,ISIPV4,CUSTOM
--
Gitblit v1.9.1