Programming Style - Revision history

Dirk: Including Code and lib-common.php

2009-05-21T17:53:27Z

Including Code and lib-common.php

Dirk: stronger coupling with pages for Geeklog coding and documentation standards

2009-05-16T17:23:42Z

stronger coupling with pages for Geeklog coding and documentation standards

Dirk: cosmetics and some minor additions/corrections

2009-05-04T10:09:52Z

cosmetics and some minor additions/corrections

Dirk: Changed category

2008-05-10T20:12:36Z

Changed category

Dirk: Removed colons from headlines

2008-05-10T19:50:21Z

Removed colons from headlines

Tomw at 20:57, 28 June 2004

2004-06-28T20:57:14Z

Tomw: =Including Code:=

2004-06-28T20:53:09Z

=Including Code:=

Tomw: =Function Declarations:=

2004-06-28T20:52:32Z

=Function Declarations:=

Tomw: =Function Calls:=

2004-06-28T20:52:08Z

=Function Calls:=

Tomw: =Control Structures:=

2004-06-28T20:51:50Z

=Control Structures:=

@@ Line 56: / Line 56: @@
 Inline documentation for classes should follow the [http://phpdoc.org/ phpDocumentor] convention, which is similar to Javadoc. Also see [[Source Code Documentation]].
-Note: the documentation files for <tt>lib-common.php</tt> and <tt>lib-security.php</tt> were generated directly from the source files by phpDocumentor.
+Note: the documentation files for [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html lib-common.php] and [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html lib-security.php] were generated directly from the source files by phpDocumentor.
 == Including Code ==
-Anywhere you are unconditionally including a class or library file, use <code>require_once()</code>. Anywhere you are conditionally including a class or library file, use <code>include_once()</code>.
+Anywhere you are unconditionally including a class or library file, use <code>require_once</code>. Anywhere you are conditionally including a class or library file, use <code>include_once</code>.
-Additionally it is recommended that all of your project includes use the fully qualified path to the include file instead of assuming the user has the current directory in the search path. Many PHP implementations don't include the current directory in the path and statements such as <code>include 'myfunctions.php'</code> will fail. Use the <code>$_CONF['path_html']</code> variable in the include statement.
+Additionally it is recommended that all of your project includes use the fully qualified path to the include file instead of assuming the user has the current directory in the search path. Many PHP installations don't include the current directory in the path and statements such as <code>include 'myfunctions.php'</code> will fail. Use the <code>$_CONF['path_html']</code> variable in the include statement.
-Example:
+'''Example:'''
-<pre>include $_CONF['path_html'] . "/myblock/mb_functions.php";</pre>
+<pre>require_once '../lib-common.php';

@@ Line 1: / Line 1: @@
 Good coding style makes your code more easily readable, fixable and modifiable by other people. It is strongly encouraged. It is a goal to which we all strive and seldom reach. We encourage you to practice good coding style. At the very least, correctly indent your code.
-The following coding style suggestions are mostly adapted from the PHP Pear project. You should see that documentation for examples if you have any questions. It can be found at [http://pear.php.net/manual/en/standards.php]. Also see Geeklog's [[Coding Guidelines]].
+The following coding style suggestions are mostly adapted from the PHP [http://pear.php.net/ PEAR] project. The PEAR coding style has also been adopted as the official Geeklog [[Coding Guidelines]].
@@ Line 54: / Line 54: @@
 == Comments ==
-Inline documentation for classes should follow the phpDocumentor convention, similar to Javadoc. More information about phpDocumentor can be found here: [http://phpdoc.org/]. Note: the documentation files for <tt>lib-common.php</tt> and <tt>lib-security.php</tt> were generated directly from the source files by phpDocumentor.
+Inline documentation for classes should follow the [http://phpdoc.org/ phpDocumentor] convention, which is similar to Javadoc. Also see [[Source Code Documentation]].
-Also see [[Source Code Documentation]].
+Note: the documentation files for <tt>lib-common.php</tt> and <tt>lib-security.php</tt> were generated directly from the source files by phpDocumentor.
@@ Line 63: / Line 63: @@
 Anywhere you are unconditionally including a class or library file, use <code>require_once()</code>. Anywhere you are conditionally including a class or library file, use <code>include_once()</code>.
-Additionally it is recommended that all of your project includes use the fully qualified path to the include file instead of assuming the user has the current directory in the search path. Many PHP implementations don't include the current directory in the path and statements such as <code>include('myfunctions.php')</code> will fail. Use the <code>$_CONF['path_html']</code> variable in the include statement.
+Additionally it is recommended that all of your project includes use the fully qualified path to the include file instead of assuming the user has the current directory in the search path. Many PHP implementations don't include the current directory in the path and statements such as <code>include 'myfunctions.php'</code> will fail. Use the <code>$_CONF['path_html']</code> variable in the include statement.
 Example:
-<pre>include($_CONF['path_html'] . "/myblock/mb_functions.php");</pre>
+<pre>include $_CONF['path_html'] . "/myblock/mb_functions.php";</pre>

@@ Line 1: / Line 1: @@
 Good coding style makes your code more easily readable, fixable and modifiable by other people. It is strongly encouraged. It is a goal to which we all strive and seldom reach. We encourage you to practice good coding style. At the very least, correctly indent your code.
-The following coding style suggestions are mostly adapted from the PHP Pear project. You should see that documentation for examples if you have any questions. It can be found at http://pear.php.net/manual/en/standards.php.
+The following coding style suggestions are mostly adapted from the PHP Pear project. You should see that documentation for examples if you have any questions. It can be found at [http://pear.php.net/manual/en/standards.php]. Also see Geeklog's [[Coding Guidelines]].
-== Naming Convention ==
+Choose a short prefix for all your global functions and variables. This makes it easy to determine where a particular function or variable came from. It also prevents naming collisions which are difficult to debug. Note that Geeklog itself follows this convention, e.g. all functions from <tt>lib-common.php</tt> start with <code>COM_</code>. In the Contact plugin the prefix CT_ was used. It can also help to prefix all global variables with an underscore, so global variables in the Contact plugin start with <code>$_CT_</code>.
-Choose a short prefix for all your global functions and variables. This makes it easy to determine where a particular function or variable came from. It also prevents naming collisions which are difficult to debug. Note that Geeklog itself follows this convention, e.g. all functions from lib-common.php start with COM_. In the Contact plugin the prefix CT_ was used. It can also help to prefix all global variables with an underscore, so global variables in the Contact plugin start with $_CT_.
+Geeklog uses this convention of any underscore and capital letters to indicate a global variable e.g. <code>$_TABLES</code>, <code>$_CONF</code>, <code>$_USER</code> variables.
 == Indenting ==
@@ Line 19: / Line 19: @@
 Control statements should have one space between the control keyword and opening parenthesis, to distinguish them from function calls. For example:
 <pre>
 if ((condition1) || (condition2)) {
@@ Line 28: / Line 29: @@
+}
 </pre>
 == Function Calls ==
@@ Line 33: / Line 35: @@
 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);
+<pre>$var = foo($bar, $baz, $quux);</pre>
 == Function Declarations ==
@@ Line 47: / Line 50: @@
+}
 </pre>
 == Comments ==
-Inline documentation for classes should follow the PHPDoc convention, similar to Javadoc. More information about PHPDoc can be found here: http://phpdocu.sourceforge.net/. Note: the documentation files for lib-common.php and lib-security.php were generated directly from the source files by PHPDocu.
+Inline documentation for classes should follow the phpDocumentor convention, similar to Javadoc. More information about phpDocumentor can be found here: [http://phpdoc.org/]. Note: the documentation files for <tt>lib-common.php</tt> and <tt>lib-security.php</tt> were generated directly from the source files by phpDocumentor.
 == Including Code ==
-Anywhere you are unconditionally including a class or library file, use require_once(). Anywhere you are conditionally including a class or library file, use include_once().
+Anywhere you are unconditionally including a class or library file, use <code>require_once()</code>. Anywhere you are conditionally including a class or library file, use <code>include_once()</code>.
-Additionally it is recommended that all of your project includes use the fully qualified path to the include file instead of assuming the user has the current directory in the seach path. Many PHP implementations don't include the current directory in the path and statements such as include('myfunctions.php') will fail. Use the  $_CONF['path_html'] variable in the include statement. Example:
 == PHP Code Tags ==
@@ Line 65: / Line 74: @@
 Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.
 [[Category:Plugin Development]]

← Older revision		Revision as of 20:12, 10 May 2008
Line 65:		Line 65:
	Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.		Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.

−	[[Category:~~Plugin_Developers_Handbook~~]]	+	[[Category:Plugin Development]]

@@ Line 5: / Line 5: @@
-== Naming Convention: ==
+== Naming Convention ==
 Choose a short prefix for all your global functions and variables. This makes it easy to determine where a particular function or variable came from. It also prevents naming collisions which are difficult to debug. Note that Geeklog itself follows this convention, e.g. all functions from lib-common.php start with COM_. In the Contact plugin the prefix CT_ was used. It can also help to prefix all global variables with an underscore, so global variables in the Contact plugin start with $_CT_.
@@ Line 11: / Line 11: @@
 Geeklog uses this convention of any underscore and capital letters to indicate a global variable e.g. $_TABLES, $_CONF, $_USER variables.
-== Indenting: ==
+== Indenting ==
 Use an indent of 4 spaces, with no tabs. Please indent your code.
-== Control Structures: ==
+== Control Structures ==
 Control statements should have one space between the control keyword and opening parenthesis, to distinguish them from function calls. For example:
@@ Line 29: / Line 29: @@
 </pre>
-== Function Calls: ==
+== 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:
@@ Line 35: / Line 35: @@
 $var = foo($bar, $baz, $quux);
-== Function Declarations: ==
+== Function Declarations ==
 Function declarations follow the "one true brace" convention:
@@ Line 48: / Line 48: @@
 </pre>
-== Comments: ==
+== Comments ==
 Inline documentation for classes should follow the PHPDoc convention, similar to Javadoc. More information about PHPDoc can be found here: http://phpdocu.sourceforge.net/. Note: the documentation files for lib-common.php and lib-security.php were generated directly from the source files by PHPDocu.
@@ Line 54: / Line 54: @@
-== Including Code: ==
+== Including Code ==
 Anywhere you are unconditionally including a class or library file, use require_once(). Anywhere you are conditionally including a class or library file, use include_once().
@@ Line 61: / Line 61: @@
 include($_CONF['path_html'] . "/myblock/mb_functions.php");
-== PHP Code Tags: ==
+== PHP Code Tags ==
 Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.
 [[Category:Plugin_Developers_Handbook]]

← Older revision		Revision as of 20:57, 28 June 2004
Line 64:		Line 64:

	Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.		Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.
		+
		+	[[Category:Plugin_Developers_Handbook]]

@@ Line 38: / Line 38: @@
 Function declarations follow the "one true brace" convention:
 function fooFunction($arg1, $arg2 = '')
+{
@@ Line 45: / Line 46: @@
      return $val;
+}
+</pre>
 == Comments: ==