View Source

<ac:macro ac:name="info"><ac:parameter ac:name="title">Temporary Location for Coding Standards Review</ac:parameter><ac:rich-text-body>
<p>The coding standards official location can be found in the <a href="http://framework.zend.com/manual/en/coding-standard.html">Zend Framework Online Manual</a> and are copied here for review and updates before being placed back into DocBook format in Subversion. The manual also contains translated versions that are not available here.</p></ac:rich-text-body></ac:macro>

<h1>Table of Contents</h1>

<ac:macro ac:name="toc-zone"><ac:parameter ac:name="location">top</ac:parameter><ac:parameter ac:name="type">list</ac:parameter><ac:parameter ac:name="style">none</ac:parameter><ac:parameter ac:name="outline">true</ac:parameter><ac:parameter ac:name="indent">20px</ac:parameter><ac:parameter ac:name="printable">true</ac:parameter><ac:rich-text-body>

<h1>Overview</h1>

<h2>Scope</h2>

<p>This document provides the coding standards and guidelines for developers and teams working on or with the Zend Framework. The subjects covered are:</p>

<ul>
<li>PHP File Formatting</li>
<li>Naming Conventions</li>
<li>Coding Style</li>
<li>Inline Documentation</li>
<li>Errors and Exceptions</li>
<li>CodeSniffer Testbed</li>
</ul>


<h2>Goals</h2>

<p>Good coding standards are important in any development project, particularly when multiple developers are working on the same project. Having coding standards helps to ensure that the code is of high quality, has fewer bugs, and is easily maintained.</p>

<p>Abstract goals we strive for:</p>
<ul>
<li>extreme simplicity</li>
<li>tool friendliness, such as use of method signatures, constants, and patterns that support IDE tools and auto-completion of method, class, and constant names.</li>
</ul>


<p>When considering the goals above, each situation requires an examination of the circumstances and balancing of various trade-offs.</p>

<h1>PHP File Formatting</h1>

<h2>General</h2>

<p>For PHP files the closing tag (&quot;<code>?&gt;</code>&quot;) is to be omitted. It is not required by PHP, and omitting it prevents trailing whitespace from being accidentally injected into the output.</p>

<ac:macro ac:name="note"><ac:parameter ac:name="title">Important</ac:parameter><ac:rich-text-body>
<p>Inclusion of arbitrary binary data as permitted by <code>__HALT_COMPILER()</code> is prohibited from any Zend framework PHP file or files derived from them. Use of this feature is only permitted for special installation scripts.</p></ac:rich-text-body></ac:macro>

<p>Also using the closing tag to generate HTML output within a method is omitted. Instead use heredoc syntax if needed.</p>

<h2>Indentation</h2>

<p>Use an indent of 4 spaces with no tab characters. Editors should be configured to treat tabs as spaces in order to prevent injection of tab characters into the source code.</p>

<p>The code following a opening brace must be indented 4 additional spaces.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
if ($x == 1) {
$indented_code = 1;
if ($new_line == 1) {
$more_indented_code = 1;
}
}
]]></ac:plain-text-body></ac:macro>

<p>Multiple assignments must have the same indentation.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$variable1 = "demo";
$var2 = "demo";
]]></ac:plain-text-body></ac:macro>

<h2>Maximum Line Length</h2>

<p>The target line length is 80 characters; i.e., developers should aim keep code as close to the 80-column boundary as is practical. However, longer lines are acceptable. The maximum length of any line of PHP code is 120 characters.</p>

<h2>Line Termination</h2>

<p>Line termination is the standard way for Unix text files. Lines must end only with a linefeed (LF). Linefeeds are represented as ordinal 10, or hexadecimal 0x0A.</p>

<p>Do not use carriage returns (CR) like Macintosh computers (0x0D).</p>

<p>Do not use the carriage return/linefeed combination (CRLF) as Windows computers (0x0D, 0x0A).</p>

<p>Lines should not contain trailing spaces. In order to facilitate this convention, most editors can be configured to strip trailing spaces, such as upon a save operation.</p>

<h1>Naming Conventions</h1>

<h2>Abstractions Used in API (Class Interfaces)</h2>

<p>When creating an API for use by application developers (as opposed to Zend Framework internal developers), if application developers must identify abstractions using a compound name, separate the names using underscores, not camelCase. For example, the name used for the MySQL PDO driver is 'pdo_mysql', not 'pdoMysql'. When the developer uses a string, normalize it to lowercase. Where reasonable, add constants to support this (e.g. PDO_MYSQL).</p>

<h2>Classes</h2>

<p>The Zend Framework employs a class naming convention whereby the names of the classes directly map to the directories in which they are stored. The root level directory of the Zend Framework is the &quot;<code>Zend/</code>&quot; directory, under which all classes are stored hierarchically.</p>

<p>Class names may only contain alphanumeric characters. Numbers are permitted in class names but are discouraged. Underscores are only permitted in place of the path separator. For example, the filename &quot;<code>Zend/Db/Table.php</code>&quot; must map to the class name &quot;<code>Zend_Db_Table</code>&quot;.</p>

<p>If a class name is comprised of more than one word, the first letter of each new word must be capitalized. Successive capitalized letters are not allowed; e.g., a class &quot;<code>Zend_PDF</code>&quot; is not allowed, while &quot;<code>Zend_Pdf</code>&quot; is acceptable.</p>

<p>Zend Framework classes that are authored by Zend or one of the participating partner companies and distributed with the Framework must always start with &quot;<code>Zend_</code>&quot; and must be stored under the &quot;<code>Zend/</code>&quot; directory hierarchy accordingly.</p>

<p>These are examples of acceptable names for classes:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
Zend_Db

Zend_View

Zend_View_Helper
]]></ac:plain-text-body></ac:macro>

<ac:macro ac:name="note"><ac:parameter ac:name="title">Important</ac:parameter><ac:rich-text-body>
<p>Code that operates with the framework but is not part of the framework, such as code written by a framework end-user and not Zend or one of the framework's partner companies, must never start with &quot;<code>Zend_</code>&quot;.</p></ac:rich-text-body></ac:macro>

<h2>Interfaces</h2>

<p>Interface classes must follow the same conventions as other classes (see above), but must end with &quot;<code>_Interface</code>&quot;, such as in these examples:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
Zend_Log_Adapter_Interface

Zend_Controller_Dispatcher_Interface
]]></ac:plain-text-body></ac:macro>

<h2>Filenames</h2>

<p>For all other files, only alphanumeric characters, underscores, and the dash character (&quot;<code>-</code>&quot;) are permitted. Spaces are prohibited.</p>

<p>Any file that contains any PHP code must end with the extension &quot;<code>.php</code>&quot;. These examples show the acceptable filenames for containing the class names from the examples in the section above:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
Zend/Db.php

Zend/Controller/Front.php

Zend/View/Helper/FormRadio.php
]]></ac:plain-text-body></ac:macro>

<p>File names must follow the mapping to class names described above.</p>

<h2>Functions and Methods</h2>

<p>Function names may only contain alphanumeric characters. Underscores are not permitted. Numbers are not allowed in function names.</p>

<p>Function names must always start with a lowercase letter. When a function name consists of more than one word, the first letter of each new word must be capitalized. This is commonly called the &quot;camelCaps&quot; method.</p>

<p>Verbosity is encouraged. Function names should be as illustrative as is practical to enhance understanding.</p>

<p>These are examples of acceptable names for functions:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
filterInput()

getElementById()

widgetFactory()
]]></ac:plain-text-body></ac:macro>

<p>For object-oriented programming, accessors for object members should always be prefixed with either &quot;<code>get</code>&quot; or &quot;<code>set</code>&quot;. When using design patterns, such as the Singleton or Factory patterns, the name of the method should contain the pattern name where practical to make the pattern more readily recognizable.</p>

<p>Though function names may not contain the underscore character, class methods that are declared as <code>protected</code> or <code>private</code> must begin with a single underscore, as in the following example:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
class Zend_Foo
{
protected function _fooBar()
{
// ...
}
}
]]></ac:plain-text-body></ac:macro>

<p>Functions in the global scope, or &quot;floating functions,&quot; are permitted but heavily discouraged. It is recommended that these functions be wrapped in a class and declared static.</p>

<p>Functions or variables declared with a &quot;static&quot; scope in a class generally should not be &quot;private&quot;, but protected instead. Use &quot;final&quot; if the function should not be extended.</p>

<p>The opening brace of functions and methods has to be in the next line.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
function Myfunction($parameter1)
{
}
]]></ac:plain-text-body></ac:macro>

<h3>Optional Parameters</h3>

<p>Use &quot;null&quot; as the default value instead of &quot;false&quot;, for situations like this:</p>

<p>public function foo($required, $optional = null)</p>

<p><strong>when</strong> $optional does not have or need a particular default value.</p>

<p>However, if an optional parameter is boolean, and its logical default value should be true, or false, then using true or false is acceptable.</p>

<h2>Variables</h2>

<p>Variable names may only contain alphanumeric characters. Underscores or numbers are not permitted.</p>

<p>For class member variables that are declared with the <code>private</code> or <code>protected</code> construct, the first character of the variable name must be a single underscore. This is the only acceptable usage of an underscore in a variable name. Member variables declared as &quot;public&quot; may never start with an underscore. For example:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
class Zend_Foo
{
protected $_bar;
}
]]></ac:plain-text-body></ac:macro>

<p>Like function names, variable names must always start with a lowercase letter and follow the &quot;camelCaps&quot; capitalization convention.</p>

<p>Verbosity is encouraged. Variable names should always be as verbose as practical. Terse variable names such as &quot;<code>$i</code>&quot; and &quot;<code>$n</code>&quot; are discouraged for anything other than the smallest loop contexts. If a loop contains more than 20 lines of code, variables for such indices or counters need to have more descriptive names.</p>

<h2>Constants</h2>

<p>Constants may contain both alphanumeric characters and the underscore. Numbers are permitted in constant names.</p>

<p>Constant names must always have all letters capitalized.</p>

<p>To enhance readability, words in constant names must be separated by underscore characters. For example, &quot;<code>EMBED_SUPPRESS_EMBED_EXCEPTION</code>&quot; is permitted but &quot;<code>EMBED_SUPPRESSEMBEDEXCEPTION</code>&quot; is not.</p>

<p>Constants must be defined as class members by using the &quot;const&quot; construct. Defining constants in the global scope with &quot;define&quot; is permitted but heavily discouraged.</p>

<h2>Booleans and the NULL Value</h2>

<p>Unlike PHP's documentation, the Zend Framework uses lowercase for both boolean values and the &quot;<code>null</code>&quot; value.</p>

<h1>Coding style</h1>

<h2>PHP Code Demarcation</h2>

<p>PHP code must always be delimited by the full-form, standard PHP tags (although you should see the note about <ac:link ac:anchor="General"><ac:link-body>the closing PHP tag</ac:link-body></ac:link>):</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
<?php

?>
]]></ac:plain-text-body></ac:macro>

<p>Short tags are only allowed within view scripts.</p>

<h2>Strings</h2>

<h3>String Literals</h3>

<p>When a string is literal (contains no variable substitutions), the apostrophe or &quot;single quote&quot; must always used to demarcate the string:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$a = 'Example String';
]]></ac:plain-text-body></ac:macro>

<h3>String Literals Containing Apostrophes</h3>

<p>When a literal string itself contains apostrophes, it is permitted to demarcate the string with quotation marks or &quot;double quotes&quot;. This is especially encouraged for SQL statements:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$sql = "SELECT `id`, `name` from `people` WHERE `name`='Fred' OR `name`='Susan'";
]]></ac:plain-text-body></ac:macro>

<p>The above syntax is preferred over escaping apostrophes.</p>

<h3>Variable Substitution</h3>

<p>Variable substitution is permitted using either of these two forms:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$greeting = "Hello $name, welcome back!";

$greeting = "Hello {$name}, welcome back!";
]]></ac:plain-text-body></ac:macro>

<p>For consistency, this form is not permitted:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$greeting = "Hello ${name}, welcome back!";
]]></ac:plain-text-body></ac:macro>

<h3>String Concatenation</h3>

<p>Strings may be concatenated using the &quot;<code>.</code>&quot; operator. A space must always be added before and after the &quot;<code>.</code>&quot; operator to improve readability:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$company = 'Zend' . 'Technologies';
]]></ac:plain-text-body></ac:macro>

<p>When concatenating strings with the &quot;<code>.</code>&quot; operator, it is permitted to break the statement into multiple lines to improve readability. In these cases, each successive line should be padded with whitespace such that the &quot;<code>.</code>&quot; operator is aligned under the &quot;<code>=</code>&quot; operator:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$sql = "SELECT `id`, `name` FROM `people` "
. "WHERE `name` = 'Susan' "
. "ORDER BY `name` ASC ";
]]></ac:plain-text-body></ac:macro>

<h2>Arrays</h2>

<h3>Numerically Indexed Arrays</h3>

<p>Negative numbers are not permitted as array indices.</p>

<p>An indexed array may be started with any non-negative number, however this is discouraged and it is recommended that all arrays have a base index of <code>0</code>.</p>

<p>When declaring indexed arrays with the <code>array</code> construct, a trailing space must be added after each comma delimiter to improve readability:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$sampleArray = array(1, 2, 3, 'Zend', 'Studio');
]]></ac:plain-text-body></ac:macro>

<p>It is also permitted to declare multi-line indexed arrays using the <code>array</code> construct. In this case, each successive line must be padded with spaces such that beginning of each line and each value aligns as shown below:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$sampleArray = array(1, 2, 3, 'Zend',
'Studio', $a, $b, $c,
56.44, $d, 500);
]]></ac:plain-text-body></ac:macro>

<h3>Associative Arrays</h3>

<p>When declaring associative arrays with the <code>array</code> construct, it is encouraged to break the statement into multiple lines. In this case, each successive line must be padded with whitespace such that both the keys and the values are aligned:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$sampleArray = array('firstKey' => 'firstValue',
'secondKey' => 'secondValue');
]]></ac:plain-text-body></ac:macro>

<h2>Classes</h2>

<h3>Class Declarations</h3>

<p>Classes must be named by following the naming conventions.</p>

<p>The brace is always written on the line underneath the class name (&quot;one true brace&quot; form).</p>

<p>Every class must have a documentation block that conforms to the phpDocumentor standard.</p>

<p>Any code within a class must be indented the standard indent of four spaces.</p>

<p>Only one class is permitted per PHP file.</p>

<p>Placing additional code in a class file is permitted but heavily discouraged. In these files, a blank line must separate the class from any additional PHP code in the file.</p>

<p>This is an example of an acceptable class declaration:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* Class Docblock Here
*/
class Zend_Class
{
// entire content of class
// must be indented four spaces
}
]]></ac:plain-text-body></ac:macro>

<h3>Class Member Variables</h3>

<p>Member variables must be named by following the variable naming conventions.</p>

<p>Any variables declared in a class must be listed at the top of the class, prior to declaring any functions.</p>

<p>The <code>var</code> construct is not permitted. Member variables always declare their visibility by using one of the <code>private</code>, <code>protected</code>, or <code>public</code> constructs. Accessing member variables directly by making them public is permitted but discouraged in favor of accessor methods having the <code>set</code> and <code>get</code> prefixes.</p>

<h2>Functions and Methods</h2>

<h3>Function and Method Declaration</h3>

<p>Functions and class methods must be named by following the naming conventions.</p>

<p>Methods must always declare their visibility by using one of the <code>private</code>, <code>protected</code>, or <code>public</code> constructs.</p>

<p>Following the more common usage in the PHP developer community, static methods should declare their visibility first:</p>
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
public static foo() { ... }
private static bar() { ... }
protected static goo() { ... }
]]></ac:plain-text-body></ac:macro>

<p>As for classes, the opening brace for a function or method is always written on the line underneath the function or method name (&quot;one true brace&quot; form). There is no space between the function or method name and the opening parenthesis for the arguments.</p>

<p>This is an example of acceptable class method declarations:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* Class Docblock Here
*/
class Zend_Foo
{
/**
* Method Docblock Here
*/
public function sampleMethod($a)
{
// entire content of function
// must be indented four spaces
}

/**
* Method Docblock Here
*/
protected function _anotherMethod()
{
// ...
}
}
]]></ac:plain-text-body></ac:macro>

<ac:macro ac:name="info"><ac:parameter ac:name="title">Please note</ac:parameter><ac:rich-text-body>
<p>Passing function or method arguments by reference is only permitted by defining the reference in the function or method declaration, as in the following example:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
function sampleMethod(&$a)
{}
]]></ac:plain-text-body></ac:macro>

<p>Call-time pass by-reference is prohibited.</p></ac:rich-text-body></ac:macro>

<p>The return value must not be enclosed in parentheses. This can hinder readability and can also break code if a function or method is later changed to return by reference.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
function foo()
{
// WRONG
return($this->bar);

// RIGHT
return $this->bar;
}
]]></ac:plain-text-body></ac:macro>

<p>The use of <a href="http://php.net/manual/en/language.oop5.typehinting.php">type hinting</a> is encouraged where possible with respect to the component design. For example,</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
class Zend_Component
{
public function foo(SomeInterface $object)
{}

public function bar(array $options)
{}
}
]]></ac:plain-text-body></ac:macro>

<p>Where possible, try to keep your use of exceptions vs. type hinting consistent, and not mix both approaches at the same time in the same method for validating argument types. However, before PHP 5.2, &quot;Failing to satisfy the type hint results in a fatal error,&quot; and might fail to satisfy other coding standards involving the use of throwing exceptions. Beginning with PHP 5.2, failing to satisfy the type hint results in an E_RECOVERABLE_ERROR, requiring developers to deal with these from within a custom error handler, instead of using a try..catch block.</p>

<h3>Function and Method Usage</h3>

<p>Function arguments are separated by a single trailing space after the comma delimiter. This is an example of an acceptable function call for a function that takes three arguments:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
threeArguments(1, 2, 3);
]]></ac:plain-text-body></ac:macro>

<p>Call-time pass by-reference is prohibited. Arguments to be passed by reference must be defined in the function declaration.</p>

<p>For functions whose arguments permit arrays, the function call may include the &quot;array&quot; construct and can be split into multiple lines to improve readability. In these cases, the standards for writing arrays still apply:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
threeArguments(array(1, 2, 3), 2, 3);

threeArguments(array(1, 2, 3, 'Zend',
'Studio', $a, $b, $c,
56.44, $d, 500), 2, 3);
]]></ac:plain-text-body></ac:macro>

<h2>Control Statements</h2>

<h3>If / Else / Elseif</h3>

<p>Control statements based on the &quot;<code>if</code>&quot;, &quot;<code>else</code>&quot;, and &quot;<code>elseif</code>&quot; constructs must have a single space before the opening parenthesis of the conditional, and a single space between the closing parenthesis and opening brace.</p>

<p>Within the conditional statements between the parentheses, operators must be separated by spaces for readability. Inner parentheses are encouraged to improve logical grouping of larger conditionals.</p>

<p>The opening brace is written on the same line as the conditional statement. The closing brace is always written on its own line. Any content within the braces must be indented four spaces.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
if ($a != 2) {
$a = 2;
}
]]></ac:plain-text-body></ac:macro>

<p>For &quot;<code>if</code>&quot; statements that include &quot;<code>elseif</code>&quot; or &quot;<code>else</code>&quot;, the formatting must be as in these examples:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
if ($a != 2) {
$a = 2;
} else {
$a = 7;
}


if ($a != 2) {
$a = 2;
} else if ($a == 3) {
$a = 4;
} else {
$a = 7;
}
]]></ac:plain-text-body></ac:macro>

<p>PHP allows for these statements to be written without braces in some circumstances. The coding standard makes no differentiation and all &quot;<code>if</code>&quot;, &quot;<code>elseif</code>&quot;, or &quot;<code>else</code>&quot; statements must use braces.</p>

<p>Use of the &quot;<code>elseif</code>&quot; construct is not allowed in favor of the &quot;<code>else if</code>&quot; combination.</p>

<h3>Switch</h3>

<p>Control statements written with the &quot;<code>switch</code>&quot; construct must have a single space before the opening parenthesis of the conditional statement, and also a single space between the closing parenthesis and the opening brace.</p>

<p>All content within the &quot;<code>switch</code>&quot; statement must be indented four spaces. Content under each &quot;<code>case</code>&quot; statement must be indented an additional four spaces.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
switch ($numPeople) {
case 1:
break;

case 2:
break;

default:
break;
}
]]></ac:plain-text-body></ac:macro>

<p>The construct &quot;<code>default</code>&quot; may never be omitted from a &quot;<code>switch</code>&quot; statement.</p>

<ac:macro ac:name="info"><ac:parameter ac:name="title">Please note</ac:parameter><ac:rich-text-body>
<p>It is sometimes useful to write a &quot;<code>case</code>&quot; statement which falls through to the next case by not including a &quot;<code>break</code>&quot; or &quot;<code>return</code>&quot;. To distinguish these cases from bugs, such &quot;<code>case</code>&quot; statements must contain the comment &quot;<code>// break intentionally omitted</code>&quot;.</p></ac:rich-text-body></ac:macro>

<h2>Global</h2>

<p>Usage of the <strong>global</strong> keyword is not allowed. Use $GLOBALS<ac:link><ri:page ri:content-title="xxx" /></ac:link> instead.</p>

<h1>Inline Documentation</h1>

<h2>General</h2>

<p>All docblock parts are compatible with the phpDocumentor format and must follow the following standard.<br />
Docblocks start always with <code>/*</code><strong>. The use of <code>/</code></strong> or <code>//</code> is only allowed for comments within functions.</p>

<p>A docblock must contain a short description and minimum one parameter.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* SHORT_DESCRIPTION
*
* @param
*/
]]></ac:plain-text-body></ac:macro>

<p>Optionally a long description and multiple parameters can be added.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* SHORT_DESCRIPTION
*
* LONG_DESCRIPTION
* SPANS MULTIPLE
* LINES
*
* @param
* @param
*/
]]></ac:plain-text-body></ac:macro>

<h2>Indenting</h2>

<p>All docblock parts which are not keywords have to be under each other with the same indenting.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* blablabla
*
* @component All descriptive parts
* @uses have the same indenting
*/
]]></ac:plain-text-body></ac:macro>

<p>Also when describing parameters the keywords, parameters, and description have to have the same indenting to be under each other.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* blablabla
*
* @param string $value Description of this value
* @param integer $othervalue Another description
*/
]]></ac:plain-text-body></ac:macro>

<h2>File Header</h2>

<p>Each file which is delivered with the Zend Framework must have the following header block:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package __PACKAGENAME__
* @subpackage __SUBPACKAGENAME__
* @copyright Copyright (c) 2005-__ENDDATE__ Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: $
* @depreciated Since 0.0.1
*/
]]></ac:plain-text-body></ac:macro>

<p>When other filestypes are used like *.SH, *.BAT, *.JS and so on, the header block must also be contained as header comment. Only when a filetype does not support comments like *.CSS the header block can be omited. The clauses must be added in the above seen order.</p>

<p>The <code>@package</code> clause has to be the component which this file is part of it, for example Zend_Db or Zend_Gdata. There are only two exceptions:<br />
All demo files are located in the component <strong>Demos</strong> and all classes in the incubator have to be handled as if they are in core... so &quot;incubator/Zend/Class&quot; becomes the component &quot;Zend_Class&quot;.<br />
There must exist exact one <code>@package</code> clause per header.</p>

<p>The <code>@subpackage</code> clause has to be a logical separation within this component. Logical separations occur when there are several directories which seperate parts of the same component. The component name if contained in the separation has to be omitted. For example a file which is in Zend/Db/Adapters/* will have <strong>Adapters</strong> as separation and <strong>Zend_Db</strong> as component. Only files which are in the main directory of the framework which is &quot;Zend&quot; can omit the subpackage. There must exist maximum one <code>@subpackage</code> clause per header.</p>

<p>The <code>@copyright</code> clause has to include the actual year of the release of the framework.</p>

<p>If this file contains a depreciated class it must have the optional <code>@depreciated</code> clause.</p>

<h2>Require Once</h2>

<p>All classes/files which are required must contain a @see clause:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* @see Zend_Controller_Dispatcher_Interface
*/
require_once 'Zend/Controller/Dispatcher/Interface.php';
]]></ac:plain-text-body></ac:macro>

<h2>Class/Interface Header</h2>

<p>A class or interface must have a class header looking like this:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* Description of the class
*
* More descriptive text which
* is allowed to span multiple lines
*
* @category Zend
* @package __PACKAGE__
* @subpackage __SUBPACKAGE__
* @uses __USES__
* @see __SEE__
* @since __SINCE__
* @copyright Copyright (c) 2005-__ENDDATE__ Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @depreciated Since 0.0.1
*/
class Zend_Controller_Dispatcher extends Zend_Controller_Dispatcher_Class implements Zend_Controller_Dispatcher_Interface
]]></ac:plain-text-body></ac:macro>

<p>The clauses must be added in the above seen order.</p>

<p>The short discription explains what this class does. It must not extend one single line.</p>

<p>The long descriptive text can be ommitted if there is no need for it.</p>

<p>The <code>@package</code> clause has to contain the component which this file is part of it, for example Zend_Db or Zend_Gdata.</p>

<p>The <code>@subpackage</code> clause has to contain a logical separation within this component. Logical separations occur when there are several directories which seperate parts of the same component. For example a file which is in Zend/Db/Adapters/* will have &quot;Zend_Db_Adapters&quot; as separation. There is only one exception: All files which are part of the demos directory have to be in the Demos subpackage. Only files which are in the main directory of the framework which is &quot;Zend&quot; can omit the subpackage.</p>

<p>The <code>@uses</code> clause has to contain the extended or implemented classname. A class which &quot;extends Zend_MyClass&quot; must have a clause @uses Zend_MyClass. Also a class which &quot;implementes Zend_MyClass&quot; must have a clause @uses Zend_MyClass. When multiple classes or interfaces are used, you must include a @uses clause for every class or interface. When no class is extended or interface is implemented then the @uses clause must be ommitted.</p>

<p>The <code>@see</code> clause is optional and can be added to link to another component within the framework. You can add multiple clauses.</p>

<p>The <code>@since</code> clause can be added optionally to include the version since which this class is available. It must include the complete version number of the framework. Only one since clause is allowed to be added.</p>

<p>The <code>@copyright</code> clause has to include the actual year of the release of the framework.</p>

<p>If this file contains a depreciated class it must have the optional <code>@depreciated</code> clause in the same format as the <code>@since</code> clause.</p>

<h2>Function Header</h2>

<p>Each function must have a function header.<br />
The header has to look like this:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
/**
* Full text description of this function. It described all possible
* things but should not extend the line length of 100 characters.
*
* @param integer $value Value for input
* @param float $other Other value
* @param string $section String for anything
* @param array $rest Rest array possible values
* Some additional description
* @param array|null $config (optional) My optional value
* @param Zend_Control $control (optional) xxx
* @since Version 1.2.3
* @see Zend_Anything
* @throws Zend_Config_Exception When value is true
* @return array
*/
]]></ac:plain-text-body></ac:macro>

<p>All parameters of the function must be available.<br />
The following types are allowed:</p>
<ul>
<li>boolean</li>
<li>integer</li>
<li>float</li>
<li>string</li>
<li>array</li>
<li>Zend_xxx (must be an existing class of the framework)</li>
<li>false</li>
<li>true</li>
<li>null</li>
</ul>


<p>If more than one type could be used then the possible types have to be seperated with <strong>&quot;|&quot;</strong> like show above.</p>

<p>If a parameter can be omitted the description must prepend a <strong>(optional)</strong> like shown above.</p>

<p>A <code>@since</code> clause can be added to show since when this function is available. Only one clause is allowed.</p>

<p>The <code>@see</code> clause can be added to link to another component which describes functionallity of this method, or which is used by this method. Multiple clauses are allowed. Every clause must contain only one class link.</p>

<p>If the function can throw an exception the <strong>@throws</strong> clause must be declared.<br />
Multiple exception types must be seperated with <strong>&quot;|&quot;</strong>. Also a description must be added why the exception is thrown.</p>

<p>A <strong>@return</strong> clause must always be defined. Only for class constructor and destructor the @return clause must be ommitted.<br />
If multiple types can be returned the types must be seperated with <strong>&quot;|&quot;</strong>.<br />
An description can be appended, but is not necessary.<br />
If the class itself is returned (fluid interface) then the description</p>
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
* @return Zend_Class *Provides a fluid interface*
]]></ac:plain-text-body></ac:macro>
<p> must be added.</p>

<p>If the function does not return any value then the return value must be set to <strong>void</strong></p>
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
* @return void
]]></ac:plain-text-body></ac:macro>

<ac:macro ac:name="note"><ac:parameter ac:name="title">Hint</ac:parameter><ac:rich-text-body>
<p>There has been discussions in past about void versus null. Keep in mind that these two are not the same. Null means that a empty variable is returned. But void means that nothing is returned. This is a small but important difference. Therefor when return is even not called, void has to be declared in the function docblock.</p></ac:rich-text-body></ac:macro>

<h2>Inline Documentation</h2>

<p>Documentation within a method is good practice and should be done to increase readability of the code.</p>

<p>The only acceptable syntax is phpdoc (&quot;<code>/*</code>&quot;) or pearl (&quot;<code>//</code>&quot;).<br />
The usage of the (&quot;<code>#</code>&quot;) or the (&quot;<code>/**</code>&quot;) Syntax is not allowed.</p>

<h1>Errors and Exceptions</h1>

<p>The Zend Framework codebase must be <code>E_STRICT</code> compliant. Zend Framework code should not emit PHP warning (E_WARNING, E_USER_WARNING), notice (E_NOTICE, E_USER_NOTICE), or strict (E_STRICT) messages when <code>error_reporting</code> is set to <code>E_ALL | E_STRICT.</code></p>

<p>See <a class="external-link" href="http://www.php.net/errorfunc">http://www.php.net/errorfunc</a> for information on <code>E_STRICT</code>.</p>

<p>Zend Framework code should not emit PHP errors, if it is reasonably possible. Instead, throw meaningful exceptions. Zend Framework components have <code>Exception</code> class derivatives specifically for this purpose:</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
class Zend_Exception extends Exception
{}

class Zend_Component_Exception extends Zend_Exception
{}

class Zend_Component_SpecificException extends Zend_Component_Exception
{}
]]></ac:plain-text-body></ac:macro>

<p>It is considered best practice within framework component code that exceptions are instantiated through the traditional <code>new</code> constructor method.</p>

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
require_once 'Zend_Component_SpecificException.php';

class Zend_Component
{
public function foo($condition)
{
if ($condition) {
throw new Zend_Component_SpecificException(
'Some meaningful exception message');
}
}
}
]]></ac:plain-text-body></ac:macro>

<p>Exceptions must be lazy loaded before they are thrown:</p>
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
if ($condition) {
require_once 'Zend_Component_SpecificException.php';
throw new Zend_Component_SpecificException(
'Some meaningful exception message');
}
]]></ac:plain-text-body></ac:macro>

<p>Reasonable care should be taken to avoid throwing exceptions except when genuinely appropriate. In general, if a Zend Framework component is asked to perform a duty that it cannot perform in a certain situation (e.g., illegal input, cannot read requested file), then throwing an exception is a sensible course of action. Conversely, if a component is able to perform its requested duty, despite some variance from expected input, then the component should continue with its work, rather than throw an exception.</p>

<h2>Exception best practices</h2>

<ul>
<li>Use specific derived exceptions in both <code>throw</code> and <code>catch</code>. See the following two items:</li>
</ul>


<ul>
<li>Avoid throwing the <code>Exception</code> base class, or other exception superclass. The more specific the exception, the better it communicates to the user what happened.</li>
</ul>


<ul>
<li>Avoid catching the <code>Exception</code> base class, or other exception superclass. If a <code>try</code> block might encounter more than one type of exception, write a separate <code>catch</code> block for each specific exception, not one <code>catch</code> block for an exception superclass.</li>
</ul>


<ul>
<li>Some classes may require you to write more than one derived exception class. Write as many exception classes as needed, to distinguish between different types of situations. For example, &quot;<em>invalid argument value</em>&quot; is different from, &quot;<em>you don't have a needed privilege</em>.&quot; Create different exceptions to identify different cases.</li>
</ul>


<ul>
<li>Don't put important diagnostic information only in the text of the exception method. Create methods and members in derived exception classes as needed, to provide information to the <code>catch</code> block. Create an exception constructor method that takes appropriate arguments, and populate the members of the class with those arguments.</li>
</ul>


<ul>
<li>Don't silently suppress exceptions and allow execution to continue in an erroneous state. If you catch an exception, either correct the condition or throw a new exception.</li>
</ul>


<ul>
<li>Keep implementation-specific exceptions isolated to the appropriate layer of your application. For instance, don't propagate <code>SQLException</code> out of the data layer code and into business layer code.</li>
</ul>


<ul>
<li>Don't use exceptions as a mechanism of flow control, or to return valid return values from a function.</li>
</ul>


<ul>
<li>Clean up resources such as database connections or network connections. PHP does not support a <code>finally</code> block as some programming languages do, so either clean up in the <code>catch</code> blocks, or else design flow control outside the <code>catch</code> block to perform cleanup, and let execution continue after the <code>catch</code>.</li>
</ul>


<ul>
<li>Use documentation from other languages for other best practices regarding using exceptions. Many of the principles are applicable, regardless of the language.</li>
</ul>


<h1>CodeSniffer Testbed</h1>

<p>The complete framework is tested with a coding standard which we have written using PHP_CodeSniffer. Several existing tests have been reused and others have been rewritten to allow automatic testing of the above written coding standard.<br />
In some points the CodeSniffer tests are more restrictive than the written standard to make the code more readable and consistent.</p>
</ac:rich-text-body></ac:macro>