From 9c9382e6949e1366c6adb502b7aacae2c11023f7 Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Thu, 08 Sep 2011 09:42:04 -0400
Subject: [PATCH] Fixed: FS#1709 - Wrong message "Your hard-disk space is going full" in the "Monitor -> Show Disk Usage"
---
CODING_NOTES.php.txt | 56 +++++++++++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 49 insertions(+), 7 deletions(-)
diff --git a/CODING_NOTES.php.txt b/CODING_NOTES.php.txt
index 2108956..9b7ae8e 100644
--- a/CODING_NOTES.php.txt
+++ b/CODING_NOTES.php.txt
@@ -1,10 +1,18 @@
Some guidelines for web development with php.
-----------------------------------------------------
-Unix Line Breaks Only, NO windows breaks please.
+* Unix Line Breaks Only, NO windows breaks please.
+* Tabs set at 4 spaces either as tabs or spaces.
+* no accidental _<?php space before, within or after a file
+* every php file starts and end with <?php ?> no spaces before or after
+* error_reporting(E_ALL|E_STRICT) , yep php5
+* Magic quotes is gone in php6, get used to it now. config = magic_quotes_gpc() Everything must be quoted
-Tabs set at 4 spaces either as tabs or spaces.
+please mark any section that need review or work on with
+// TODO
+* Add documentation about access levels (public, private, protected).
+* Make function / var names on the following way, first word lower, next word(s) first letter upper like. getFirstResult();
-Pear coding guiidelines
+Pear coding guidelines
//*****************************************************************************
// Commenting style
@@ -35,7 +43,7 @@
// print_r($foo);
-For incline comment use //** and //* eg
+For inline comment use //** and //* eg
//** Decide what do do
switch($decide){
@@ -58,7 +66,7 @@
Do not use the phpdoc on every function, eg
/**
-* Login an user
+* Login a user
* @param string user username
* @param string password of user
*/
@@ -67,7 +75,7 @@
.......
}
<<
-as this function explains its self, the followinf clean code will suffice
+as this function explains its self, the following clean code will suffice
>>
function login($user, $pass){
.......
@@ -76,7 +84,7 @@
If you do need to explain a function then put un the summary syntax eg
/** Pass an array of values where third param is bar
-* $foo['bar'] = 1; // allow an user
+* $foo['bar'] = 1; // allow a user
* $foo['bar'] = 2; // destroy user
* $foo['bar'] = -1; // recreate
*/
@@ -84,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