https://github.com/iadvize/php-convention
PHP conventions at iAdvize
https://github.com/iadvize/php-convention
Last synced: 11 months ago
JSON representation
PHP conventions at iAdvize
- Host: GitHub
- URL: https://github.com/iadvize/php-convention
- Owner: iadvize
- Created: 2013-12-23T10:42:42.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T14:43:25.000Z (about 2 years ago)
- Last Synced: 2024-11-07T21:08:46.279Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 98.6 KB
- Stars: 15
- Watchers: 55
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# DEPRECATED, move to https://docs.iadvize.io/RFCs/php/?h=php
# iAdvize PHP Style Guide
1. [IDE Integration](#installation)
1. [Files](#files)
1. [Lines](#lines)
1. [Keywords](#keywords)
1. [Comments](#comments)
1. [Naming](#naming)
1. [Variables](#variables)
1. [Constants](#constants)
1. [Type casting](#type-casting)
1. [Namespaces and use declarations](#namespaces-use)
1. [String](#strings)
1. [Arrays](#arrays)
1. [Classes, Properties, and Methods](#classes)
1. [Interfaces, Traits](#interfaces)
1. [Function and Method Calls](#function-method-calls)
1. [Control Structures](#control-structures)
1. [Closures](#closures)
1. [Best practices](#best-practices)
[](https://www.youtube.com/watch?v=7XO5crQkR4Y)
### Troubleshooting
If you have this `phpcs: PHP Fatal error: Uncaught exception 'PHP_CodeSniffer_Exception' with message 'Referenced sniff "Symfony2" does not exist'`
Launch this: `./vendor/bin/phpcs --config-set installed_paths $PWD/vendor/escapestudios/symfony2-coding-standard,$PWD/vendor/iadvize/php-convention/phpcs`
## Files
- Use only `UTF-8 without BOM`.
- Use only the Unix LF (linefeed) line ending.
- All PHP files must end with a single blank line.
- Use the long `` tags for non-views scripts.
```php
` tags for view scripts.
```php
=∙$title;∙?>
```
- The closing `?>` tag must be omitted from files containing only PHP.
- Limit on line length limit must be `200 characters`.
- File must contain only one statement of namespace.
- Code must use `4 spaces` for indenting, not tabs.
## Lines
- Blank lines may be added to improve readability and to indicate related blocks of code.
```php
// nah
function foo()
{
$foo = 'test';
$foo = strtoupper($foo);
return $foo;
}
// good
function bar()
{
$foo = 'test';
$foo = strtoupper($foo);
return $foo;
}
```
- There must not be more than one statement per line.
```php
// bad
$foo = substr(strtoupper('test'), 0, 1);
// good
$foo = 'test';
$foo = strtoupper($foo);
$foo = substr($foo, 0, 1);
```
## Keywords
- All PHP keywords must be in lower case (Eg: `true`, `false`, `null`, etc.)
## Namespaces and use declarations
- Namespaces names must be delcared in `UpperCamelCase`.
```php
// bad
namespace Vendor\fooBar;
// bad
namespace Vendor\foo_bar;
// good
namespace Vendor\FooBar;
```
- Namespaces declaration never begin by a backslash `Vendor\Space\Space`.
- There must be one blank line before and after the `namepsace` declaration.
- There must be one blank line after the block of `use` declaration.
- `use` declaration must not separated by comma.
- `use` block declarations must be grouped by package:
```php
// bad
use Foo\Bar,
Qux\Quux,
Foo\Baz;
// bad
use Foo\Bar;
use Qux\Quux;
use Foo\Baz;
// good
use Foo\Bar;
use Foo\Baz;
use Qux\Quux;
use Qux\Corge\Grault;
```
- `use` alias declaration should be composed with sub-namespaces names.
```php
// bad
use Foo\Bar as Baz;
// bad
use Baz\Qux\Quux as BQQ;
// good
use Foo\Bar as FooBar;
// good
use Baz\Qux\Quux as BazQuxQuux;
```
## Comments
### In-line code comments
- Comments should be on a separate line immediately before the code line or block they reference.
```php
// bad
$foo = 'bar'; // Bar in foo
// good
// Foo assignment for example
$foo = 'bar';
// good
// Foo assignment
// for example
$foo = 'bar';
```
### Block code comments
- You must add PHPDoc blocks for all classes, methods, and functions, but you can omit the `@return` tag if the method does not return anything.
```php
/**
* Foo
*
*/
class Foo
{
/**
* The description of bar
*
* @param string $baz The baz
*
* @return string The return of bar
*/
public function bar($baz)
{
// Returned value
return 'Do something...';
}
}
```
- You must add PHPDoc blocks for all variable references.
```
/** @var Bar\Baz $foo Baz object */
$foo = $bar->baz();
```
```php
/**
* Foo
*
*/
class Foo
{
/** @var string $bar It's bar! */
public $bar = '';
}
```
- You must not use full qualified class name in PHPDoc blocks. This means you have to declare the class name with a use declaration even if she is not referenced elsewhere from the PHPBlock.
```php
// Bad
namespace Vendor\Bar\Baz;
/**
* Foo
*
*/
class Foo
{
/** @var \Other\MyClass $myClass */
protected $myClass;
/**
* @return \Other\MyClass
*/
public function getMyClass()
{
return $this->myClass;
}
}
```
```php
// Good
namespace Vendor\Bar\Baz;
use Other\MyClass;
/**
* Foo
*
*/
class Foo
{
/** @var MyClass $myClass */
protected $myClass;
/**
* @return MyClass
*/
public function getMyClass()
{
return $this->myClass;
}
}
```
- `@todo` and `@fixme` must be used in PHPDoc blocks like annotations.
```php
/** @todo Think to check value */
$foo = 'bar';
/** @fixme Change qux to quux */
$baz = 'qux';
```
### Qualify objects you use
- you should add `@var` tag when you get object from abstract method
```php
// bad
$logger = $this->getServiceLocator()->get('logger');
// bad
$this->getServiceLocator()->get('AwesomeFactory')->createAwesomeness();
// good
/** @var LoggerInterface $logger */
$logger = $this->getServiceLocator()->get('logger');
// good
/** @var AwesomeFactory $awesomeFactory */
$awesomeFactory = $this->getServiceLocator()->get('AwesomeFactory');
$awesomeFactory->createAwesomeness()
```
- you shouldn't add `@var` tag when you get object from explicit method
```php
// bad
/**
* Class AwesomeFactory
*/
class AwesomeFactory
{
/**
* @return Awesome
*/
public function createAwesomeness()
{
return Awesome();
}
}
$awesomeFactory = new AwesomeFactory();
/** @var Awesome $awesome */
$awesome = $awesomeFactory->createAwesomeness();
// good
/**
* Class AwesomeFactory
*/
class AwesomeFactory
{
/**
* @return Awesome
*/
public function createAwesomeness()
{
return Awesome();
}
}
$awesomeFactory = new AwesomeFactory();
$awesome = $awesomeFactory->createAwesomeness();
```
## Naming
- Clarity over brevity in variable, method and class names
```php
// bad
$o = new Object();
// bad
class A
{
}
// bad
public function doIt()
{
}
// good
$object = new Object();
// good
class Substracter
{
}
// good
public function associateChannelToOperator()
{
}
```
- `Boolean` variable names should be either an adjective or a past participle form.
Associated getter method should begin with `is` or `has`.
```php
// bad
$enablePlugin = true;
// bad
public function getEnablePlugin() {}
// bad
public function getPluginEnabled() {}
// good
$pluginEnabled = true;
// good
$visible = true;
// good
public function isPluginEnabled() {}
// good
public function isVisible() {}
```
- `DateTime` variable names should be a past participle form ending with `At`.
```php
// bad
$dateUpdate = new \DateTime;
// bad
$endDate = new \DateTime;
// good
$updatedAt = new \DateTime;
// good
$lastLoggedAt = new \DateTime;
```
## Variables
### User variables
- Variables should be in `lowerCamelCase`.
```php
// bad
$_foo='';
// bad
$foo_bar = '';
// bad
$fooBar='';
// good
$fooBar∙=∙'';
```
- You must set off operators with spaces.
```php
// bad
$foo = (5+6)/5;
// good
$foo∙=∙(5∙+∙6)∙/∙5;
```
- You must conserve a great alignment.
```php
// bad
$foo = 'Ba';
$foo .= 'r';
$quux = 'Qu';
$quux .= 'x';
// good
$foo = 'Ba';
$foo .= 'r';
$quux = 'Qu';
$quux .= 'x';
```
```php
// bad
$fooBarBazQux->bar()->
baz()->qux();
// good
$fooBarBazQux
∙∙∙∙->bar()
∙∙∙∙->baz()
∙∙∙∙->qux();
```
### Global variables
- You must used `$_POST`, `$_GET` and `$_COOKIE` instead of `$_REQUEST`. If you use a framework, use `Request` component.
## Strings
- A string must be enclosed in single quotes `'hello'`.
- A concatenated string must use single quotes `'foo' . $bar`
- A concatenated string must use spaces around points `'foo' . $bar`
- A string declaration in multiline must be aligned
```php
$foo = 'Bar'
.'Baz'
.'Qux';
```
- A string must not concatenate with functions or methods
```php
// bad
$foo = ucfisrt('bar') . ' baz';
// good
$foo = ucfirst('bar');
$foo = $foo . ' baz';
// very good
$foo = ucfirst('bar');
$foo .= ' baz';
```
## Constants
### Class constants
- Constants must be in `UPPER_SNAKE_CASE`.
```php
// bad
const MAXSIZE=5;
// bad
const max_size∙=∙4;
// good
const MAX_SIZE∙=∙5;
```
- You must set assignment operator with spaces.
```php
// bad
const MAX_SIZE=5;
// good
const MAX_SIZE∙=∙5;
```
- You must conserve a great alignment.
```php
// bad
const FOO∙∙=∙'Ba';
const FOO∙∙=∙'r';
const QUUX∙=∙'Qu';
const QUUX∙=∙'x';
// good
const FOO∙∙=∙'Ba';
const FOO∙∙=∙'r';
const QUUX∙=∙'Qu';
const QUUX∙=∙'x';
```
## Type casting
- You must use `(int) $foo` instead of `intval($foo)`.
- You must use `(bool) $foo` instead of `boolval($foo)`.
- You must use `(float) $foo` instead of `floatval($foo)`.
- You must use `(string) $foo` instead of `strval($foo)`.
```php
// bad
$foo∙=∙(string)$bar;
// good
$foo∙=∙(string)∙$bar;
```
## Arrays
- You must use `[]` notation instead of `array()`.
- Arrays with few data must be declared like this:
```php
$foo∙=∙['Bar',∙'Baz',∙'Qux'];
```
- Arrays with lots of data must be declared like this:
```php
$foo = [
∙∙∙∙'bar'∙∙=>∙'abc',
∙∙∙∙'baz'∙∙=>∙123,
∙∙∙∙'qux'∙∙=>∙true,
∙∙∙∙'quux'∙=>∙[
∙∙∙∙∙∙∙∙'corge'∙∙=>∙[],
∙∙∙∙∙∙∙∙'grault'∙=>∙123.456,
∙∙∙∙],
];
```
- For the arrays with lots of data, lines must be terminated by a comma. (Easy to copy/paste)
## Classes, Properties, and Methods
### Classes
- The `extends` and `implements` keywords should be declared on the same line as the class name.
- The opening brace for the class must go on its own line; the closing brace for the class must go on the next line after the body.
```php
Interfaces, Traits
### Interfaces
- The interface name must be suffixed with `Interface`.
```php
bar = $bar;
}
}
```
- There must not be a space between the method or function name and the opening parenthesis.
```php
// bad
foo∙();
$bar->baz∙();
// good
foo();
$bar->baz();
```
- There must not be a space after the opening parenthesis and there must not be a space before the closing parenthesis. In the argument list.
```php
// bad
foo(∙$qux∙);
$bar->baz(∙$qux∙);
// good
foo($qux);
$bar->baz($qux);
```
- There must not be a space before each comma and there must be one space after each comma.
```php
// bad
foo($bar∙,∙$baz∙,∙$qux);
// good
foo($bar,∙$baz,∙$qux);
```
- Argument lists may be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list must be on the next line, and there must be only one argument per line.
```php
// bad
foo($longFoo,
$longBar,
$longBaz
);
// bad
foo($longFoo,
$longBar,
$longBaz);
// good
foo(
∙∙∙∙$longFoo,
∙∙∙∙$longBar,
∙∙∙∙$longBaz
);
```
- Chained method calls must be wrapped before the first call and indented once.
```php
// bad
$fooBar->baz()->qux($param);
// good
$fooBar
->baz()
->qux($param);
```
- When you pass an array as the only argument, the array brackets should be on the same lines as the method parenthesis.
```php
// bad
foo(
[
'foo' => 'bar',
]
);
// good
foo([
'foo' => 'bar',
]);
```
### General
- There must be one space after the control structure keyword
- There must not be a space after the opening parenthesis
- There must not be a space before the closing parenthesis
- There must be one space between the closing parenthesis and the opening brace
- The structure body must be indented once
- The closing brace must be on the next line after the body
- The body of each structure must be enclosed by braces. This standardizes how the structures look, and reduces the likelihood of introducing errors as new lines get added to the body.
### `if`, `elseif`, `else`
- The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words.
#### Example
```php
// bad
if(EXPRESSION){
// Do something...
}
// bad
if (EXPRESSION) {
// Do something...
}
// bad
if (EXPRESSION)
{
// Do something...
}
// bad
if (EXPRESSION) {
// Do something...
}
else {
// Do something...
}
// good
if∙(EXPRESSION)∙{
∙∙∙∙// Do something...
}∙elseif∙(OTHER_EXPRESSION)∙{
∙∙∙∙// Do something...
}∙else∙{
∙∙∙∙// Do something...
}
```
### Ternary (`?:`)
- You should not use nesting ternary.
#### Example
```php
// bad
$foo = EXPRESSION ? 'bar' : OTHER_EXPRESSION ? 'baz' : 'qux';
// good
$foo∙=∙EXPRESSION∙?∙'bar'∙:∙'baz';
// good
$foo∙=∙EXPRESSION
∙∙∙∙?∙'bar'
∙∙∙∙:∙'baz';
```
### `switch` and `case`
- The `case` statement must be indented once from `switch`, and the `break` keyword (or other terminating keyword) must be indented at the same level as the `case` body.
- There must be a comment such as `// no break` when fall-through is intentional in a non-empty case body.
#### Example
```php
// bad
switch(EXPRESSION)
{
case 0:
// Do something...
break;
}
// good
switch∙(EXPRESSION)∙{
∙∙∙∙case∙0:
∙∙∙∙∙∙∙∙// Do something...
∙∙∙∙∙∙∙∙break;
∙∙∙∙case∙1:
∙∙∙∙∙∙∙∙// Do something with no break...
∙∙∙∙∙∙∙∙// no break
∙∙∙∙case∙2:
∙∙∙∙case∙3:
∙∙∙∙case∙4:
∙∙∙∙∙∙∙∙// Do something with return instead of break...
∙∙∙∙∙∙∙∙return;
∙∙∙∙default:
∙∙∙∙∙∙∙∙// Do something in default case...
∙∙∙∙∙∙∙∙break;
}
```
### `while` and `do while`
#### Example
```php
// bad
while(EXPRESSION)
{
// Do something...
}
// bad
do
{
// Do something...
} while(EXPRESSION);
// good
while∙(EXPRESSION)∙{
∙∙∙∙// Do something...
}
// good
do∙{
∙∙∙∙// Do something...
}∙while∙(EXPRESSION);
```
### `for`
#### Example
```php
// bad
for( $i=0;$i<10;$i++ )
{
// Do something...
}
// good
for∙($i∙=∙0;∙$i∙<∙10;∙$i++)∙{
∙∙∙∙// Do something...
}
```
### `foreach`
#### Example
```php
// bad
foreach( $foo as $key=>$value )
{
// Do something...
}
// good
foreach∙($foo∙as∙$key∙=>∙$value)∙{
∙∙∙∙// Do something...
}
```
### `try` and `catch`
#### Example
```php
// bad
try
{
// Do something...
}
catch(FooException $e)
{
// Do something...
}
// good
try∙{
∙∙∙∙// Do something...
}∙catch∙(FooException∙$exception)∙{
∙∙∙∙// Do something...
}∙catch∙(BarException∙$exception)∙{
∙∙∙∙// Do something...
}∙finally∙{
∙∙∙∙// Do something...
}
```
## Closures
- Closures must be declared with a space after the function keyword, and a space before and after the use keyword.
- The opening brace must go on the same line, and the closing brace MUST go on the next line following the body.
- There must not be a space after the opening parenthesis of the argument list or variable list, and there must not be a space before the closing parenthesis of the argument list or variable list.
- In the argument list and variable list, there must not be a space before each comma, and there must be one space after each comma.
- Closure arguments with default values must go at the end of the argument list.
- Argument lists and variable lists may be split across multiple lines, where each subsequent line is indented once.
- When doing so, the first item in the list must be on the next line, and there must be only one argument or variable per line.
- When the ending list (whether or arguments or variables) is split across multiple lines, the closing parenthesis and opening brace must be placed together on their own line with one space between them.
### Example (declaration)
```php
// good
$closureWithArguments∙=∙function∙($foo,∙$bar)∙{
∙∙∙∙// Do something...
};
// good
$closureWithArgumentsAndVariables∙=∙function∙($foo,∙$bar)∙use∙($baz,∙$qux)∙{
∙∙∙∙// Do something...
};
// good
$longArgumentsNoVariables∙=∙function∙(
∙∙∙∙$longArgumentFoo,
∙∙∙∙$longArgumentBar,
∙∙∙∙$longArgumentBaz
)∙{
∙∙∙∙// Do something...
};
// good
$noArgumentsLongVariables∙=∙function∙()∙use∙(
∙∙∙∙$longVariableFoo,
∙∙∙∙$longVariablBar,
∙∙∙∙$longVariableBaz
)∙{
∙∙∙∙// Do something...
};
// good
$longArgumentsLongVariables∙=∙function∙(
∙∙∙∙$longArgumentFoo,
∙∙∙∙$longArgumentBar,
∙∙∙∙$longArgumentBaz
)∙use∙(
∙∙∙∙$longVariableFoo,
∙∙∙∙$longVariableBar,
∙∙∙∙$longVariableBaz
)∙{
∙∙∙∙// Do something...
};
// good
$longArgumentsShortVariables∙=∙function∙(
∙∙∙∙$longArgumentFoo,
∙∙∙∙$longArgumentBar,
∙∙∙∙$longArgumentBaz
)∙use∙($variableFoo)∙{
∙∙∙∙// Do something...
};
// good
$shortArgumentsLongVariables∙=∙function∙($argumentFoo)∙use∙(
∙∙∙∙$longVariableFoo,
∙∙∙∙$longVariableBar,
∙∙∙∙$longVariableBaz
)∙{
∙∙∙∙// Do something...
};
```
### Example (usage)
```php
$foo->bar(
∙∙∙∙$argumentFoo,
∙∙∙∙function∙($argumentBar)∙use∙($variableFoo)∙{
∙∙∙∙∙∙∙∙// Do something...
∙∙∙∙},
∙∙∙∙$argumentBaz
);
```
### Date
- You must use `new \DateTime('2014-01-01 00:00:00')` instead of `date('2014-01-01 00:00:00')`.
- You must use `new \DateTime('Sunday')` instead of `strtotime('Sunday')`.
### Readibility
- When possible, avoid nestings of more than 2 levels and prefer "return early" structures.
```php
// bad
$response = [];
if ($foo) {
foreach ($foo->getBars() as $bar) {
if ($bar->hasBaz()) {
// 3 nested levels
}
}
}
return $response;
// good
$response = [];
if (!$foo) {
return $response;
}
foreach ($foo->getBars() as $bar) {
if ($bar->hasBaz()) {
// only 2 nested levels
}
}
return $response;
```