Coding StandardsG2 - Revision history

Mjec: /* return Statements */ PHP (rather than C++) code

2005-07-13T23:27:16Z

‎return Statements: PHP (rather than C++) code

Vinny: /* Document Header */

2005-01-23T03:20:18Z

‎Document Header

Vinny: /* SQL code layout */

2004-12-17T21:00:27Z

‎SQL code layout

Vinny: /* Sessions */

2004-12-17T20:59:53Z

‎Sessions

Vinny: /* Naming Convention */

2004-12-17T20:56:28Z

‎Naming Convention

Vinny: /* Acknowledgements */

2004-12-17T20:53:27Z

‎Acknowledgements

Vinny: /* Naming Convention */

2004-12-17T20:49:40Z

‎Naming Convention

Tomw: Reverted edit of BestWeb, changed back to last version by Tomw

2004-12-10T01:14:10Z

Reverted edit of BestWeb, changed back to last version by Tomw

Show changes

BestWeb at 17:19, 9 December 2004

2004-12-09T17:19:41Z

Show changes

Tomw: revert

2004-08-30T14:20:30Z

revert

Show changes

@@ Line 206: / Line 206: @@
        return;
-       return $myDisk.size();
+       return $myDisk->size();
        return ($argv * $argc - $defaultValue);

@@ Line 433: / Line 433: @@
 === Document Header ===
-All files should contain the following text in a form where it will not interfere with the purpose of the file (ie, commented out). In this example, it's presented in a commented out form for inclusion into PHP files.  The following header is tentative awaiting adecision on what licensing scheme to use for Geeklog2.
+All files should contain the following text in a form where it will not interfere with the purpose of the file (ie, commented out). In this example, it's presented in a commented out form for inclusion into PHP files.  The following header is tentative awaiting a decision on what licensing scheme to use for Geeklog2.
 <pre>

@@ Line 578: / Line 578: @@
 </pre>
-=== SQL code layout ====
+=== SQL code layout ===
 Since we'll all be using different editor settings, don't try to do anything complex like aligning columns in SQL code. Do, however, break statements onto their own lines. Here's a sample of how SQL code should look. Note where the lines break, the capitalization, and the use of brackets. Examples:

@@ Line 541: / Line 541: @@
 === Sessions ===
-GL2 will use PHP sessions for session management.  The $_SESSION array will be available globally for storing session date.  Since session information will be stored in a database, the size of data kept in the $_SESSION array should be kept as small as possible.
+GL2 will use PHP sessions for session management.  The $_SESSION array will be available globally for storing session data.  Since session information will be stored in a database, the size of data kept in the $_SESSION array should be kept as small as possible.
 == Miscellaneous ==

← Older revision		Revision as of 20:56, 17 December 2004
Line 129:		Line 129:

	Naming conventions make programs more understandable by making them easier to read. They can also give information about the function of the identifier-for example, whether it's a constant, package, or class-which can be helpful in understanding the code.		Naming conventions make programs more understandable by making them easier to read. They can also give information about the function of the identifier-for example, whether it's a constant, package, or class-which can be helpful in understanding the code.
		+
		+	Geeklog 2 uses the idea of names spaces to prevent different plugins from using the same class or table names. Plugins should prefix both classes and tables by the plugin name followed by an underscore.

	In the block below, we'll refer to a capitalization strategy called StudlyCaps. In this strategy, multiple words are combined into one where the beginning of each internal word is capitalized. Acronyms are capitalized like regular words. For example a variable expressing the "maximum cpu speed" would be called $maximumCpuSpeed.		In the block below, we'll refer to a capitalization strategy called StudlyCaps. In this strategy, multiple words are combined into one where the beginning of each internal word is capitalized. Acronyms are capitalized like regular words. For example a variable expressing the "maximum cpu speed" would be called $maximumCpuSpeed.

@@ Line 20: / Line 20: @@
 * [http://www.k-fish.de/krabutzig/phpwebsite/devdoc.html#comments phpWebSitedeveloper documentation]
-In some places we've copied it verbatim. Please don't sue us, we've got no money anyway. If you modify and redistribute this document please maintain the above credits and giveus some also. The original Gallery version was mostly written by Bharat Mediratta with input fromChris Smith, Matthew McEachen and Jesse Mullan. Modifications for Geeklog were added by Vincent Furia.
+In some places we've copied it verbatim. Please don't sue us, we've got no money anyway. If you modify and redistribute this document please maintain the above credits and give us some also. The original Gallery version was mostly written by Bharat Mediratta with input from Chris Smith, Matthew McEachen and Jesse Mullan. Modifications for Geeklog were added by Vincent Furia.
 == Indentation ==

@@ Line 132: / Line 132: @@
 In the block below, we'll refer to a capitalization strategy called StudlyCaps. In this strategy, multiple words are combined into one where the beginning of each internal word is capitalized. Acronyms are capitalized like regular words. For example a variable expressing the "maximum cpu speed" would be called $maximumCpuSpeed.
-<table border="1" width="600">
+{| border=1 width=600
+!Type
-    <tr>
+!Description
-      <th> Type </th>
+!width=200|Examples
-      <th> Description </th>
+|-
-      <th width="200"> Examples </th>
+|Files
-    </tr>
+|File names are in StudlyCaps with the first letter capitalized. Try to keep your file names simple and descriptive.<br><br>Files that contain PHP code (including php classes) should end in .php. Files that contain a PHP class definition should contain a class of the same name as the file (minus the name space).
+|<code> Geeklog.php </code>
-    <tr>
+|-
-      <td> Files </td>
+|Classes
-      <td> File names are in StudlyCaps with the first letter
+|Class names are in StudlyCaps and should be nouns. Classes should be prefixed with the plugin name (or "Geeklog" for core classes) followed by an underscore (_). Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).
-capitalized. Try to keep your file names simple and descriptive. <br>
+|<code> class Geeklog_PasswordGenerator <br> class Forum_Post <br> class Geeklog_UrlGenerator </code>
-      <br>
+|-
-Files that contain PHP code should end in .php. Files that contain a
+|Variables
-PHP class definition
+|Variables are in StudlyCaps and should have a lowercase first letter. Variable names should not start with underscore (_) or dollar sign ($) characters, even though both are allowed. <br><br> Variable names should be short yet meaningful. The choice of a variable name should be mnemonic- that is, designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary "throwaway" variables such as loop indices. Common names for temporary variables are i, j, k, m, and n for integers; and c, d, and e for characters.
-should end in .class.php, and should also contain a class of the same
+|<code> var $fields; <br> var $userInformation; <br> var $linkUrl; </code>
-name
+|-
-as the file. </td>
+|Functions
-      <td> <code> Geeklog.php <br>
+|Functions are in StudlyCaps and should be verbs. Functions that return boolean values should be in the form of a question as in "isEnabled". The noun-verb formation makes code easier to read, eg "Is the user enabled?" becomes "if ($user-&gt;isEnabled)".
-Geeklog.class.php </code> </td>
+|<code> function getField() <br> function setField() <br> function isEnabled() </code>
-    </tr>
+|-
+|Constants
-    <tr>
+|The names of variables declared class constants and of ANSI constants should be all uppercase with words separated by underscores ("_"). (ANSI constants should be avoided, for ease of debugging.) Constants used in localization should begin with an underscore.
-      <td> Classes </td>
+|<code> $MIN_WIDTH = 4; <br> $FULL_ONLY_MODE = 2; </code>
-      <td> Class names are in StudlyCaps and should be nouns. Try
+|-
-to keep your class names simple and descriptive. Use whole words-avoid
+|Tables
-acronyms and abbreviations (unless the abbreviation is much more widely
+|The names of all tables should be prefixed by the plugin's name and the geeklog table prefix.  Table names should be all lower case and spaces should be represented by the underscore character (_).
-used than the long form, such as URL or HTML). </td>
+|<code> &lt;table_prefix&gt;_&lt;plugin_name&gt;_table </code>
-      <td> <code> class PasswordGenerator <br>
+|}
 == Class and Function Declarations ==