Joomla!开发代码书写规范 【转】

<?php if ((condition1) || (condition2)) {     action1(); } elseif ((condition3) && (condition4)) {     action2(); } else {    // Use one true brace in control structures    // when the block is longer than one line     defaultaction();     anotheraction(); } ?>

<?php
switch (condition)
{
    case 1:
        action1;
        break;
 
    case 2:
        action2;
        break;
 
    default:
        defaultaction;
        break;
}
?>

<?php
$var = foo( $bar, $baz, $quux );
?>

<?php
$short         = foo( $bar );
$long_variable = foo( $baz );
?>
 

<?php function fooFunction( $arg1, $arg2 = '' ) {     if (condition) {         statement;     }     return $val; }   class fooClass {     function fooMethod( $arg1 )     {         if ($arg) {             $result = true;         } else {             $result = false;         }         return $result;     } } ?>

<?php
function connect( &$dsn, $persistent = false )
{
    if (is_array($dsn)) {
        $dsninfo = &$dsn;
    } else {
        $dsninfo = DB::parseDSN($dsn);
    }
 
    if (!$dsninfo || !$dsninfo['phptype']) {
        return $this->raiseError();
    }
 
    return true;
}
?>

$state = 1;
$name  = 'bill';
$db    = &JFactory::getDBO();
$query = 'SELECT COUNT( c.id ) AS num_articles, u.id, u.username'.
    ' FROM jos_content AS c'.
    ' LEFT JOIN jos_users AS u ON u.id = c.created_by'.
    ' WHERE c.state = '.(int) $state
    '  AND u.id IS NOT NULL'.
    '  AND u.username <> '.$db->Quote( $name ).
    ' GROUP BY u.id'.
    '  H***ING COUNT( c.id ) > 0';
$db->setQuery();
// Output formated query:
if ($debug) {
    echo $db->getQuery();
}
$stats = $db->loadObjectList();

<?php   /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */   /**  * Short description for file  *  * Long description for file (if any)...  *  * PHP versions 4 and 5  *  * LICENSE: This source file is subject to version 3.0 of the PHP license  * that is available through the world-wide-web at the following URI:  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of  * the PHP License and are unable to obtain it through the web, please  * send a note to 
 license@php.net so we can mail you a copy immediately.  *  * @category   CategoryName  * @package    PackageName  * @author     Original Author <
 author@example.com>  * @author     Another Author <
 another@example.com>  * @copyright  1997-2005 The PHP Group  * @license    http://www.php.net/license/3_0.txt  PHP License 3.0  * @version    CVS: $Id:$  * @link       http://pear.php.net/package/PackageName  * @see        NetOther, Net_Sample::Net_Sample()  * @since      File available since Release 1.2.0  * @deprecated File deprecated in Release 2.0.0  */   /*  * Place includes, constant defines and $_GLOBAL settings here.  * Make sure they have appropriate docblocks to avoid phpDocumentor  * construing they are documented by the page-level docblock.  */   /**  * Short description for class  *  * Long description for class (if any)...  *  * @category   CategoryName  * @package    PackageName  * @author     Original Author <
 author@example.com>  * @author     Another Author <
 another@example.com>  * @copyright  1997-2005 The PHP Group  * @license    http://www.php.net/license/3_0.txt  PHP License 3.0  * @version    Release: @package_version@  * @link       http://pear.php.net/package/PackageName  * @see        NetOther, Net_Sample::Net_Sample()  * @since      Class available since Release 1.2.0  * @deprecated Class deprecated in Release 2.0.0  */ class foo { }   ?>
 

命名空间

connect()
 getData()
 buildSomeWidget()
 XML_RPC_serializeData()
 

_sort()
 _initTree()
 $this->_status
 

<?php
/**
 * Content Controller
 * @package Joomla
 */
ContentController
{
    // Methods
}
?>
 

<?php
/**
 * Banner Client Controller
 * @package Joomla
 */
BannerControllerClient
{
    // Methods
}
?>
 

Single Controller
 
com_content
/- controller.php
 
Multi-controller
 
com_banner
/- controllers
  /- banner.php
  /- client.php
 

<?php
/**
 * Banner Client Model
 * @package Joomla
 */
BannerModelClient
{
    // Methods
}
?>
 

Views 
Layouts 
Templates 
Template Layout Overrides