Commit 7cfbd748 authored by zYne's avatar zYne

--no commit message

--no commit message
parent 39332298
...@@ -69,7 +69,7 @@ $sampleArray = array('first' => 'firstValue', ...@@ -69,7 +69,7 @@ $sampleArray = array('first' => 'firstValue',
+++ Classes +++ Classes
* Classes must be named by following the naming conventions. * Classes must be named by following the naming conventions.
* The brace is always written right after the class name (or interface declaration). * The brace is always written next line after the class name (or interface declaration).
* Every class must have a documentation block that conforms to the PHPDocumentor standard. * Every class must have a documentation block that conforms to the PHPDocumentor standard.
* Any code within a class must be indented four spaces. * Any code within a class must be indented four spaces.
* Only one class is permitted per PHP file. * Only one class is permitted per PHP file.
...@@ -81,7 +81,8 @@ This is an example of an acceptable class declaration: ...@@ -81,7 +81,8 @@ This is an example of an acceptable class declaration:
/** /**
* Documentation here * Documentation here
*/ */
class Doctrine_SampleClass { class Doctrine_SampleClass
{
// entire content of class // entire content of class
// must be indented four spaces // must be indented four spaces
} }
...@@ -92,7 +93,7 @@ class Doctrine_SampleClass { ...@@ -92,7 +93,7 @@ class Doctrine_SampleClass {
* Methods must be named by following the naming conventions. * Methods must be named by following the naming conventions.
* Methods must always declare their visibility by using one of the private, protected, or public constructs. * Methods must always declare their visibility by using one of the private, protected, or public constructs.
* 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. * Like classes, the brace is always written next line after the method name. There is no space between the function name and the opening parenthesis for the arguments.
* Functions in the global scope are strongly discouraged. * Functions in the global scope are strongly discouraged.
* This is an example of an acceptable function declaration in a class: * This is an example of an acceptable function declaration in a class:
...@@ -100,11 +101,13 @@ class Doctrine_SampleClass { ...@@ -100,11 +101,13 @@ class Doctrine_SampleClass {
/** /**
* Documentation Block Here * Documentation Block Here
*/ */
class Foo { class Foo
{
/** /**
* Documentation Block Here * Documentation Block Here
*/ */
public function bar() { public function bar()
{
// entire content of function // entire content of function
// must be indented four spaces // must be indented four spaces
} }
...@@ -117,11 +120,13 @@ class Foo { ...@@ -117,11 +120,13 @@ class Foo {
/** /**
* Documentation Block Here * Documentation Block Here
*/ */
class Foo { class Foo
{
/** /**
* Documentation Block Here * Documentation Block Here
*/ */
public function bar(&$baz) { public function bar(&$baz)
{
} }
} }
</code> </code>
...@@ -133,7 +138,8 @@ class Foo { ...@@ -133,7 +138,8 @@ class Foo {
/** /**
* Documentation Block Here * Documentation Block Here
*/ */
class Foo { class Foo
{
/** /**
* WRONG * WRONG
*/ */
...@@ -143,7 +149,8 @@ class Foo { ...@@ -143,7 +149,8 @@ class Foo {
/** /**
* RIGHT * RIGHT
*/ */
public function bar() { public function bar()
{
return $this->bar; return $this->bar;
} }
} }
...@@ -195,20 +202,12 @@ if ($foo != 2) { ...@@ -195,20 +202,12 @@ if ($foo != 2) {
} }
</code> </code>
* PHP allows for these statements to be written without braces in some circumstances, the following format for if statements is also allowed: When ! operand is being used it must use the following formatting:
<code type="php"> <code type="php">
if ($foo != 1) if ( ! $foo) {
$foo = 1;
else
$foo = 3;
if ($foo != 2) }
$foo = 2;
elseif ($foo == 1)
$foo = 3;
else
$foo = 11;
</code> </code>
* 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. * 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.
......
...@@ -59,10 +59,35 @@ Following rules must apply to all constants used within Doctrine framework: ...@@ -59,10 +59,35 @@ Following rules must apply to all constants used within Doctrine framework:
* Constants must be defined as class members by using the "const" construct. Defining constants in the global scope with "define" is NOT permitted. * Constants must be defined as class members by using the "const" construct. Defining constants in the global scope with "define" is NOT permitted.
<code type="php"> <code type="php">
class Doctrine_SomeClass { class Doctrine_SomeClass
{
const MY_CONSTANT = 'something'; const MY_CONSTANT = 'something';
} }
print Doctrine_SomeClass::MY_CONSTANT; print Doctrine_SomeClass::MY_CONSTANT;
</code> </code>
+++ Record columns +++ Record columns
* All record columns must be in lowercase
* Usage of _ is encouraged for columns that consist of more than one word
<code type="php">
class User
{
public function setTableDefinition()
{
$this->hasColumn('home_address', 'string');
}
}
</code>
* Foreign key fields must be in format [tablename]_[column]
<code type="php">
class Phonenumber
{
public function setTableDefinition()
{
// this field is a foreign key that points to user(id)
$this->hasColumn('user_id', 'integer');
}
}
</code>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment