CONTRIBUTING.md 4.13 KB
Newer Older
1
# Some guidelines for web development with php.
2
-----------------------------------------------------
3
* Unix Line Breaks Only, NO windows breaks please.
4
* Tabs to indent lines, NO spaces
5
* no accidental _<?php space before, within or after a file
6 7
* every PHP file starts and end with <?php ?> no spaces before or after
* error_reporting(E_ALL|E_STRICT), yep PHP 5
8
* Magic quotes is gone, get used to it now. config = magic_quotes_gpc() Everything must be quoted
9 10
* Don't use ereg, split and other old function -> gone in PHP 5.4
* Don't use features that are not supported in PHP 5.3, for compatibility with LTS OS releases, ISPConfig must support PHP 5.3+
11
* Don't use shorttags. A Shorttag is <? and that is confusing with <?xml -> always usw <?php
Marius Burkard's avatar
Marius Burkard committed
12
* Don't use namespaces
tbrehm's avatar
tbrehm committed
13 14 15
* Column names in database tables and database table names are in lowercase
* Classes for the interface are located in interface/lib/classes/ and loaded with $app->uses() or $app->load() functions.
* Classes for the server are located in server/lib/classes/ and loaded with $app->uses() or $app->load() functions.
16
* please mark any section that need review or work on with /* TODO: short description */
17
* Make function / var names on the following way, first word lower, next word(s) first letter upper like. getFirstResult();
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
* always a space but NO newline before opening braces, e. g.
class abc {
	public function cde() {
		if($a == $b) {
			return false;
		}
	}
}
* no spaces after function/method or control names, e. g.
function abc($x, $y) {
	if($condition == true) {
		$x = 2;
	}
}
and NOT
function abc ($x, $y) {
	if ( $condition == true ) {
	
	}
}
38 39 40 41 42 43 44 45

//*****************************************************************************
// Commenting style
//*****************************************************************************

The comments break down into the following types
// is uses for removing lines and debug dev etc
/* 
46
	is used to comment out blocks
47
*/
48

49
/** is used to create documentaion
50 51 52
 * thats over 
 * lines
 */
53 54 55 56

If you need to block out a section then use
/*
function redundant_code(){
57
	something here
58 59 60 61 62 63 64 65 66 67
}
*/

To block out single lines use // and all // are assumed to be redundant test code and NOT comments

// print_r($foo);

Do not use the phpdoc on every function, eg 

/**
68
* Login a user
69 70 71 72 73
* @param string user  username
* @param string password of user
*/
>>
function login($user, $pass){
74
	
75 76
}
<<
77
as this function is self-explaining, the following clean code will suffice
78 79
>>
function login($user, $pass){
80
	
81 82 83
}


84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
//*****************************************************************************
// 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');

113

114 115 116 117 118
//*****************************************************************************
// 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
119