=========================================================================== || Horde Coding Standards || =========================================================================== ------------- [1] Indenting ============= Use an indent of 4 spaces, with no tabs. ---------------------- [2] Control Structures ====================== These include if, for, while, switch, etc. Here is an example if statement, since it is the most complicated of them: if ((condition1) || (condition2)) { action1; } elseif ((condition3) && (condition4)) { action2; } else { defaultaction; } Control statements should have one space between the control keyword and opening parenthesis, to distinguish them from function calls. Do not omit the curly braces under any circumstance. In the case of a large number of short tests and actions, the following is acceptable: if (condition) { action; } if (condition 2) { action 2; } ... For switch statements: switch (condition) { case 1: action1; break; case 2: action2; break; default: defaultaction; break; } ------------------ [3] Function Calls ================== Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; spaces between commas and each parameter, and no space between the last parameter, the closing parenthesis, and the semicolon. Here's an example: $var = foo($bar, $baz, $quux); As displayed above, there should be one space on either side of an equals sign used to assign the return value of a function to a variable. In the case of a block of related assignments, more space may be inserted to promote readability: $short = foo($bar); $long_variable = foo($baz); ------------------------ [4] Function Definitions ======================== Function declaractions follow the "one true brace" convention: function fooFunction($arg1, $arg2 = '') { if (condition) { statement; } return $val; } Arguments with default values go at the end of the argument list. Always attempt to return a meaningful value from a function if one is appropriate. Functions used only in the current script/class (e.g. private member methods) should begin with a '_' character (e.g. _exampleLibrary). This helps distinguish these private function calls from other, public function calls. -------------------- [5] Naming Libraries ==================== Libraries (any file located in the 'lib/' directory of the application) should be named with capital letters at the beginning of each word. Use studlycaps for naming; a session cache class would be stored in lib/SessionCache.php. If the library/class is extended, the extending files should be stored in a directory under 'lib/' with the same name as the original library. Subclasses follow the exact same naming requirements, except that if the subclass is instantiated by a factory method, it should be all lowercase. Example: The "Example Library" library should be saved as "lib/ExampleLibrary.php". Any file extending the library/class should be stored in the directory "lib/ExampleLibrary/". ------------ [6] Comments ============ Inline documentation for classes should follow the Javadoc convention. An overview of the Javadoc standard can be found here: http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html ------------------ [7] Including Code ================== If you are including a class, function library, or anything else which would cause a parse error if included twice, always use include_once. This will ensure that no matter how many factory methods we use or how much dynamic inclusion we do, the library will only be included once. If you are including a static filename, such as a conf file or a template that is _always_ used, use require. If you are dynamically including a filename, or want the code to only be used conditionally (an optional template), use include. ----------------- [8] PHP Code Tags ================= Always use to delimit PHP code, not the shorthand. This is required for PEAR compliance and is also the most portable way to include PHP code on differing operating systems and setups. In templates, make sure to use this as well (), as the shortcut version () does not work with short_open_tags turned off. ------------------------- [9] Header Comment Blocks ========================= All source code files in the Horde distribution should contain the following comment block as the header: Example for LGPL'ed Horde code: /* * $Horde: horde/docs/CODING_STANDARDS,v 1.32.2.14 2002/08/07 21:01:21 slusarz Exp $ * * Copyright 1999, 2000, 2001 Original Author * Copyright 2001 Your Name * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. */ Example for GPL'ed application code: /* * $Horde: horde/docs/CODING_STANDARDS,v 1.32.2.14 2002/08/07 21:01:21 slusarz Exp $ * * Copyright 1999, 2000, 2001 Original Author * Copyright 2001 Your Name * * See the enclosed file COPYING for license information (GPL). If you * did not receive this file, see http://www.fsf.org/copyleft/gpl.html. */ There's no hard rule to determine when a new code contributer should be added to the list of authors for a given source file. In general, their changes should fall into the "substantial" category (meaning somewhere around 10% to 20% of code changes). Exceptions could be made for rewriting functions or contributing new logic. Simple code reorganization or bug fixes would not justify the addition of a new individual to the list of authors. ------------- [10] CVS Tags ============= Include the Horde CVS vendor tag in each file. As each file is edited, add this tag if it's not yet present (or replace existing forms such as Id, "Last Modified:", etc.). EXCEPTION: Don't include these in templates. ----------------- [11] Example URLs ================= Use "example.com" for all example URLs, per RFC 2606. --------------------- [12] php.ini settings ===================== All Horde code should work with register_globals = Off. This means using $_COOKIE, $_SESSION, $_SERVER, and $_ENV to access all cookie, session, server, and environment data, respectively. To retrieve posted data (in the global $_GET and $_POST variables), you should normally use Horde::getFormData() which will automatically run dispelMagicQuotes(). This will ensure that all Horde code will work regardless of the setting of magic_quotes_gpc. The only time you want to explicitly use $_POST is when you wish to actively ignore $_GET data as a security precaution. All Horde code should work with error_reporting = E_ALL. Failure to do so would result in ugly output, error logs getting filled with lots of warning messages, or even downright broken scripts. No Horde code should assume that '.' is in the include path. Always specify './' in front of a filename when you are including a file in the same directory. ------------------------- [13] XHTML 1.0 Compliance ========================= All tag names and parameters must be lower case including javascript event handlers: ... ... All tag parameters must be of a valid parameter="value" form (numeric values must also be surrounded by quotes). For parameters that had no value in HTML, the parameter name is the value. For example: Example All tags must be properly closed. Tags where closing is forbidden must end with a space and a slash:
Example All form definitions must be on their own line and either fully defined within a pair or be outside table tags. Forms must also always have an action parameter:
example
All JavaScript tags must have a valid language and type parameters: Nothing may appear after , therefore include any common footers after all other output. All images must have an alt attribute: <?= _(" /> (On the HEAD branch) (On the RELENG_2 branch) Input fields of type "image" do not allow the border attribute and may render with a border on some browsers. Use the following instead: -------------------------------- [14] Database Naming Conventions ================================ All database tables used by Horde resources and Horde applications need to make sure that their table and field names work in all databases. Many databases reserve words like 'uid', 'user', etc. for internal use, and forbid words that are SQL keywords (select, where, etc.). Also, all names should be lowercase, with underscores ('_') to separate words, to avoid case sensitivity issues. A good way to do this for field names is to make the field name tablename_fieldname. Other general guidelines: Table names should be plural (users); field names should be singular (user_name). --------------------------- [15] Regular Expression Use =========================== Always use the preg_* functions if possible instead of ereg_* (and preg_split() instead of split()); they are included in PHP by default and much more efficient and much faster than ereg_*. NEVER use a regular expression to match or replace a static string. explode() (in place of split()), str_replace(), strstr(), or strtr() do the job much more efficiently. ---------------------- [16] Parameter Passing ====================== Objects should be passed by reference. Everything else, including arrays, should be passed by value wherever semantically possible. [Zend Engine 2: objects should also be passed by value] This practice takes full advantage of reference counting. --------------- [17] Long Lines =============== Wrap lines at 80 characters, including comments, unless this severely impacts the clarity of the code. Always wrap comments. ---------------- [18] Line Breaks ================ Only use UNIX style of linebreak (\n), not Windows/DOS/Mac style (\r\n). Using vim, to convert from dos style type :set ff=unix Using vi, to convert from dos style type :g/^M/s///g (Note that the ^M is a control character, and to reproduce it when you type in the vi command you have to pad it first using the special ^V character.) ---------------------- [19] Private Variables ====================== Variables used exclusively within a class should begin with a underscore ('_') character. An example class variable definition: var $_variablename;