Added coding standards, fixes #140
This commit is contained in:
zYne
parent
05a23f6a30
commit
1f58e34b12
12
manual/codes/Coding standards - Coding Style - Arrays.php
Normal file
12
manual/codes/Coding standards - Coding Style - Arrays.php
Normal file
@ -0,0 +1,12 @@
|
||||
<?php
|
||||
$sampleArray = array('Doctrine', 'ORM', 1, 2, 3);
|
||||
|
||||
|
||||
$sampleArray = array(1, 2, 3,
|
||||
$a, $b, $c,
|
||||
56.44, $d, 500);
|
||||
|
||||
|
||||
$sampleArray = array('first' => 'firstValue',
|
||||
'second' => 'secondValue');
|
||||
|
||||
@ -0,0 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* Documentation here
|
||||
*/
|
||||
class Doctrine_SampleClass {
|
||||
// entire content of class
|
||||
// must be indented four spaces
|
||||
}
|
||||
18
manual/codes/Coding standards - Coding Style - Strings.php
Normal file
18
manual/codes/Coding standards - Coding Style - Strings.php
Normal file
@ -0,0 +1,18 @@
|
||||
<?php
|
||||
// literal string
|
||||
$string = 'something';
|
||||
|
||||
// string contains apostrophes
|
||||
$sql = "SELECT id, name FROM people WHERE name = 'Fred' OR name = 'Susan'";
|
||||
|
||||
// variable substitution
|
||||
$greeting = "Hello $name, welcome back!";
|
||||
|
||||
// concatenation
|
||||
$framework = 'Doctrine' . ' ORM ' . 'Framework';
|
||||
|
||||
// concatenation line breaking
|
||||
|
||||
$sql = "SELECT id, name FROM user "
|
||||
. "WHERE name = ? "
|
||||
. "ORDER BY name ASC";
|
||||
@ -0,0 +1,6 @@
|
||||
<?php
|
||||
class Doctrine_SomeClass {
|
||||
const MY_CONSTANT = 'something';
|
||||
}
|
||||
print Doctrine_SomeClass::MY_CONSTANT;
|
||||
?>
|
||||
@ -0,0 +1 @@
|
||||
|
||||
15
manual/docs/Coding standards - Coding Style - Arrays.php
Normal file
15
manual/docs/Coding standards - Coding Style - Arrays.php
Normal file
@ -0,0 +1,15 @@
|
||||
<ul>
|
||||
<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:
|
||||
</ul>
|
||||
21
manual/docs/Coding standards - Coding Style - Classes.php
Normal file
21
manual/docs/Coding standards - Coding Style - Classes.php
Normal file
@ -0,0 +1,21 @@
|
||||
<ul>
|
||||
<li \>Classes must be named by following the naming conventions.
|
||||
</ul>
|
||||
<ul>
|
||||
<li \>The brace is always written right after the class name (or interface declaration).
|
||||
</ul>
|
||||
<ul>
|
||||
<li \>Every class must have a documentation block that conforms to the PHPDocumentor standard.
|
||||
</ul>
|
||||
<ul>
|
||||
<li \>Any code within a class must be indented four spaces.
|
||||
</ul>
|
||||
<ul>
|
||||
<li \>Only one class is permitted per PHP file.
|
||||
</ul>
|
||||
<ul>
|
||||
<li \>Placing additional code in a class file is NOT permitted.
|
||||
</ul>
|
||||
This is an example of an acceptable class declaration:
|
||||
|
||||
|
||||
@ -0,0 +1,75 @@
|
||||
<?php ?>
|
||||
<ul>
|
||||
<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.
|
||||
</ul>
|
||||
@ -0,0 +1,99 @@
|
||||
<?php ?>
|
||||
<ul>
|
||||
<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:
|
||||
</ul>
|
||||
<?php
|
||||
renderCode("<?php
|
||||
threeArguments(array(1, 2, 3), 2, 3);
|
||||
|
||||
threeArguments(array(1, 2, 3, 'Framework',
|
||||
'Doctrine', 56.44, 500), 2, 3);
|
||||
?>");
|
||||
?>
|
||||
|
||||
@ -0,0 +1,35 @@
|
||||
Documentation Format
|
||||
<ul>
|
||||
<li \>All documentation blocks ("docblocks") must be compatible with the phpDocumentor format. Describing the phpDocumentor format is beyond the scope of this document. For more information, visit: http://phpdoc.org/
|
||||
</ul>
|
||||
|
||||
Methods:
|
||||
<ul>
|
||||
<li \>Every method, must have a docblock that contains at a minimum:
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>A description of the function
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>All of the arguments
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>All of the possible return values
|
||||
</ul>
|
||||
|
||||
|
||||
<ul>
|
||||
<li \>It is not necessary to use the "@access" tag because the access level is already known from the "public", "private", or "protected" construct used to declare the function.
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>If a function/method may throw an exception, use @throws:
|
||||
</ul>
|
||||
|
||||
|
||||
<ul>
|
||||
<li \>@throws exceptionclass [description]
|
||||
</ul>
|
||||
@ -0,0 +1,4 @@
|
||||
PHP code must always be delimited by the full-form, standard PHP tags (<?php ?>)
|
||||
|
||||
Short tags are never allowed. For files containing only PHP code, the closing tag must always be omitted
|
||||
|
||||
18
manual/docs/Coding standards - Coding Style - Strings.php
Normal file
18
manual/docs/Coding standards - Coding Style - Strings.php
Normal file
@ -0,0 +1,18 @@
|
||||
<ul>
|
||||
<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:
|
||||
</ul>
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
<ul>
|
||||
<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.
|
||||
</ul>
|
||||
@ -0,0 +1,10 @@
|
||||
Following rules must apply to all constants used within Doctrine framework:
|
||||
|
||||
<ul><li \> Constants may contain both alphanumeric characters and the underscore.</ul>
|
||||
|
||||
<ul><li \> Constants must always have all letters capitalized.</ul>
|
||||
|
||||
<ul><li \> For readablity reasons, words in constant names must be separated by underscore characters. For example, ATTR_EXC_LOGGING is permitted but ATTR_EXCLOGGING is not.
|
||||
</ul>
|
||||
<ul><li \> Constants must be defined as class members by using the "const" construct. Defining constants in the global scope with "define" is NOT permitted.
|
||||
</ul>
|
||||
@ -0,0 +1,14 @@
|
||||
<ul>
|
||||
<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.
|
||||
</ul>
|
||||
@ -0,0 +1,20 @@
|
||||
<ul>
|
||||
<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.
|
||||
</ul>
|
||||
@ -0,0 +1,9 @@
|
||||
<ul>
|
||||
<li \>Interface classes must follow the same conventions as other classes (see above), however must end with the word "Interface"
|
||||
(unless the interface is approved not to contain it such as Doctrine_Overloadable). Some examples:
|
||||
<br \><br \>
|
||||
|
||||
Doctrine_DB_EventListener_Interface <br \>
|
||||
<br \>
|
||||
Doctrine_EventListener_Interface <br \>
|
||||
</ul>
|
||||
@ -0,0 +1,13 @@
|
||||
All variables must satisfy the following conditions:
|
||||
|
||||
<ul>
|
||||
<li \>Variable names may only contain alphanumeric characters. Underscores are not permitted. Numbers are permitted in variable names but are discouraged.
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>Variable names must always start with a lowercase letter and follow the "camelCaps" capitalization convention.
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li \>Verbosity is encouraged. Variables should always be as verbose as practical. Terse variable names such as "$i" and "$n" are discouraged for anything other than the smallest loop contexts. If a loop contains more than 20 lines of code, the variables for the indices need to have more descriptive names.
|
||||
</ul>
|
||||
0
manual/docs/Coding standards - Overview - Goals.php
Normal file
0
manual/docs/Coding standards - Overview - Goals.php
Normal file
0
manual/docs/Coding standards - Overview - Scope.php
Normal file
0
manual/docs/Coding standards - Overview - Scope.php
Normal file
@ -0,0 +1,4 @@
|
||||
For files that contain only PHP code, the closing tag ("?>") is never permitted. It is not required by PHP. Not including it prevents trailing whitespace from being accidentally injected into the output.
|
||||
<br \><br \>
|
||||
IMPORTANT: Inclusion of arbitrary binary data as permitted by __HALT_COMPILER() is prohibited from any Zend framework PHP file or files derived from them. Use of this feature is only permitted for special installation scripts.
|
||||
|
||||
@ -0,0 +1 @@
|
||||
Use an indent of 4 spaces, with no tabs.
|
||||
@ -0,0 +1,9 @@
|
||||
<ul>
|
||||
<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).
|
||||
</ul>
|
||||
@ -0,0 +1 @@
|
||||
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.
|
||||
@ -44,7 +44,7 @@ function render($title,$t,$e) {
|
||||
}
|
||||
|
||||
function render_block($name) {
|
||||
$h = new PHP_Highlight;
|
||||
|
||||
if(file_exists("docs/$name.php")) {
|
||||
$c = file_get_contents("docs/$name.php");
|
||||
if(substr($c,0,5) == "<?php") {
|
||||
@ -56,7 +56,12 @@ function render_block($name) {
|
||||
if(file_exists("codes/$name.php")) {
|
||||
$c = file_get_contents("codes/$name.php");
|
||||
$c = trim($c);
|
||||
renderCode($c);
|
||||
}
|
||||
}
|
||||
function renderCode($c = null) {
|
||||
if( ! empty($c)) {
|
||||
$h = new PHP_Highlight;
|
||||
$h->loadString($c);
|
||||
|
||||
print "<table width=500 border=1 class='dashed' cellpadding=0 cellspacing=0>";
|
||||
@ -66,7 +71,6 @@ function render_block($name) {
|
||||
print "</td></tr>";
|
||||
print "</table>";
|
||||
}
|
||||
}
|
||||
}
|
||||
function array2path($array, $path = '') {
|
||||
$arrayValues = array();
|
||||
@ -110,6 +114,7 @@ $menu = array("Getting started" =>
|
||||
"Composite",
|
||||
"Sequential")
|
||||
),
|
||||
/**
|
||||
"Schema reference" =>
|
||||
array(
|
||||
"Data types" => array(
|
||||
@ -128,6 +133,7 @@ $menu = array("Getting started" =>
|
||||
),
|
||||
|
||||
),
|
||||
*/
|
||||
"Basic Components" =>
|
||||
array(
|
||||
"Manager"
|
||||
@ -368,7 +374,42 @@ $menu = array("Getting started" =>
|
||||
"INSERT",
|
||||
"UPDATE"),
|
||||
),
|
||||
"Real world examples" => array("User management system","Forum application","Album lister")
|
||||
"Real world examples" => array("User management system","Forum application","Album lister"),
|
||||
|
||||
"Coding standards" => array(
|
||||
"Overview" =>
|
||||
array(
|
||||
"Scope",
|
||||
"Goals"
|
||||
),
|
||||
"PHP File Formatting" => array(
|
||||
"General",
|
||||
"Indentation",
|
||||
"Maximum line length",
|
||||
"Line termination"
|
||||
),
|
||||
|
||||
"Naming Conventions" => array(
|
||||
"Classes",
|
||||
"Interfaces",
|
||||
"Filenames",
|
||||
"Functions and methods",
|
||||
"Variables",
|
||||
"Constants",
|
||||
"Record columns",
|
||||
),
|
||||
|
||||
|
||||
"Coding Style" => array(
|
||||
"PHP code demarcation",
|
||||
"Strings",
|
||||
"Arrays",
|
||||
"Classes",
|
||||
"Functions and methods",
|
||||
"Control statements",
|
||||
"Inline documentation"
|
||||
),
|
||||
)
|
||||
);
|
||||
|
||||
|
||||
@ -409,12 +450,12 @@ $menu = array("Getting started" =>
|
||||
if( ! file_exists("docs/$title - $k - $v2.php")) {
|
||||
$missing[0]++;
|
||||
$str .= " [ <font color='red'>doc</font> ] ";
|
||||
//touch("docs/$title - $k - $v2.php");
|
||||
touch("docs/$title - $k - $v2.php");
|
||||
}
|
||||
if( ! file_exists("codes/$title - $k - $v2.php")) {
|
||||
$missing[1]++;
|
||||
$str .= " [ <font color='red'>code</font> ] ";
|
||||
//touch("codes/$title - $k - $v2.php");
|
||||
touch("codes/$title - $k - $v2.php");
|
||||
|
||||
}
|
||||
|
||||
@ -427,12 +468,12 @@ $menu = array("Getting started" =>
|
||||
if( ! file_exists("docs/$title - $t.php")) {
|
||||
$missing[0]++;
|
||||
$str .= " [ <font color='red'>doc</font> ] ";
|
||||
//touch("docs/$title - $t.php");
|
||||
touch("docs/$title - $t.php");
|
||||
}
|
||||
if( ! file_exists("codes/$title - $t.php")) {
|
||||
$missing[1]++;
|
||||
$str .= " [ <font color='red'>code</font> ] ";
|
||||
//touch("codes/$title - $t.php");
|
||||
touch("codes/$title - $t.php");
|
||||
}
|
||||
print "<dd>".$e." <a href=\"".$_SERVER['PHP_SELF']."?index=$i#$e\">".$t."</a>$str<br>\n";
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user