<li\>Negative numbers are not permitted as indices.
</ul>
<ul>
<li\>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 0.
</ul>
<ul>
<li\>When declaring indexed arrays with the array construct, a trailing space must be added after each comma delimiter to improve readability.
</ul>
<ul>
<li\>It is also permitted to declare multiline indexed arrays using the "array" construct. In this case, each successive line must be padded with spaces.
</ul>
<ul>
<li\>When declaring associative arrays with the array 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:
<li\>Control statements based on the if and elseif constructs must have a single space before the opening parenthesis of the conditional, and a single space after the closing parenthesis.
</ul>
<ul>
<li\>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.
</ul>
<ul>
<li\>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.
</ul>
<?php
renderCode("<?php
if (\$foo != 2) {
\$foo = 2;
}");
?>
<ul>
<li\>For "if" statements that include "elseif" or "else", the formatting must be as in these examples:
</ul>
<?php
renderCode("<?php
if (\$foo != 1) {
\$foo = 1;
} else {
\$foo = 3;
}
if (\$foo != 2) {
\$foo = 2;
} elseif (\$foo == 1) {
\$foo = 3;
} else {
\$foo = 11;
}");
?>
<ul>
<li\>PHP allows for these statements to be written without braces in some circumstances, the following format for if statements is also allowed:
</ul>
<?php
renderCode("<?php
if (\$foo != 1)
\$foo = 1;
else
\$foo = 3;
if (\$foo != 2)
\$foo = 2;
elseif (\$foo == 1)
\$foo = 3;
else
\$foo = 11;
");
?>
<ul>
<li\>Control statements written with the "switch" construct must have a single space before the opening parenthesis of the conditional statement, and also a single space after the closing parenthesis.
</ul>
<ul>
<li\>All content within the "switch" statement must be indented four spaces. Content under each "case" statement must be indented an additional four spaces but the breaks must be at the same indentation level as the "case" statements.
</ul>
<?php
renderCode("<?php
switch (\$case) {
case 1:
case 2:
break;
case 3:
break;
default:
break;
}
?>");
?>
<ul>
<li\>The construct default may never be omitted from a switch statement.
<li\>Methods must be named by following the naming conventions.
</ul>
<ul>
<li\>Methods must always declare their visibility by using one of the private, protected, or public constructs.
</ul>
<ul>
<li\>Like classes, the brace is always written right after the method name. There is no space between the function name and the opening parenthesis for the arguments.
</ul>
<ul>
<li\>Functions in the global scope are strongly discouraged.
</ul>
<ul>
<li\>This is an example of an acceptable function declaration in a class:
</ul>
<?php
renderCode("<?php
/**
* Documentation Block Here
*/
class Foo {
/**
* Documentation Block Here
*/
public function bar() {
// entire content of function
// must be indented four spaces
}
}");
?>
<ul>
<li\>Passing by-reference is permitted in the function declaration only:
</ul>
<?php
renderCode("<?php
/**
* Documentation Block Here
*/
class Foo {
/**
* Documentation Block Here
*/
public function bar(&\$baz) {
}
}
");
?>
<ul>
<li\>Call-time pass by-reference is prohibited.
</ul>
<ul>
<li\>The return value must not be enclosed in parentheses. This can hinder readability and can also break code if a method is later changed to return by reference.
</ul>
<?php
renderCode("<?php
/**
* Documentation Block Here
*/
class Foo {
/**
* WRONG
*/
public function bar() {
return(\$this->bar);
}
/**
* RIGHT
*/
public function bar() {
return \$this->bar;
}
}");
?>
<ul>
<li\>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:
</ul>
<?php
renderCode("<?php
threeArguments(1, 2, 3);
?>");
?>
<ul>
<li\>Call-time pass by-reference is prohibited. See the function declarations section for the proper way to pass function arguments by-reference.
</ul>
<ul>
<li\>For functions whose arguments permitted arrays, the function call may include the "array" construct and can be split into multiple lines to improve readability. In these cases, the standards for writing arrays still apply:
<li\>When a string is literal (contains no variable substitutions), the apostrophe or "single quote" must always used to demarcate the string:
</ul>
<ul>
<li\>When a literal string itself contains apostrophes, it is permitted to demarcate the string with quotation marks or "double quotes". This is especially encouraged for SQL statements:
</ul>
<ul>
<li\>Variable substitution is permitted using the following form:
</ul>
<ul>
<li\>Strings may be concatenated using the "." operator. A space must always be added before and after the "." operator to improve readability:
</ul>
<ul>
<li\>When concatenating strings with the "." 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 "."; operator is aligned under the "=" operator:
<li\>The Doctrine ORM Framework uses the same class naming convention as PEAR and Zend framework, where the names of the classes directly
map to the directories in which they are stored. The root level directory of the Doctrine Framework is the "Doctrine/" directory,
under which all classes are stored hierarchially.
</ul>
<ul>
<li\>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, eg. the filename "Doctrine/Table/Exception.php" must map to the class name "Doctrine_Table_Exception".
</ul>
<ul>
<li\>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 "Zend_PDF" is not allowed while "Zend_Pdf" is acceptable.
<li\>For all other files, only alphanumeric characters, underscores, and the dash character ("-") are permitted. Spaces are prohibited.
</ul>
<ul>
<li\>Any file that contains any PHP code must end with the extension ".php". These examples show the acceptable filenames for containing the class names from the examples in the section above:
<br\><br\>
Doctrine/Db.php <br\>
<br\>
Doctrine/Connection/Transaction.php <br\>
</ul>
<ul>
<li\>File names must follow the mapping to class names described above.
<li>Function names may only contain alphanumeric characters. Underscores are not permitted. Numbers are permitted in function names but are discouraged.
</ul>
<ul>
<li>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 "studlyCaps" or "camelCaps" method.
</ul>
<ul>
<li>Verbosity is encouraged. Function names should be as verbose as is practical to enhance the understandability of code.
</ul>
<ul>
<li>For object-oriented programming, accessors for objects should always be prefixed with either "get" or "set". This applies to all classes except for Doctrine_Record which has some accessor methods prefixed with 'obtain' and 'assign'. The reason
for this is that since all user defined ActiveRecords inherit Doctrine_Record, it should populate the get / set namespace as little as possible.
</ul>
<ul>
<li>Functions in the global scope ("floating functions") are NOT permmitted. All static functions should be wrapped in a static class.
<li\>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.
</ul>
<ul>
<li\>Do not use carriage returns (CR) like Macintosh computers (0x0D).
</ul>
<ul>
<li\>Do not use the carriage return/linefeed combination (CRLF) as Windows computers (0x0D, 0x0A).
