Public | Automated Build

Last pushed: a year ago
Short Description
Auto build for php-convention
Full Description

Naoned PHP Style Guide

<a name='TOC'>Table of Contents</a>

  1. Getting Started
  2. IDE Integration
  3. Files
  4. Lines
  5. Keywords
  6. Comments
  7. Naming
  8. Variables
  9. Type casting
  10. Namespaces and use declarations
  11. String
  12. Arrays
  13. Classes, Properties, and Methods
  14. Interfaces, Traits
  15. Function and Method Calls
  16. Control Structures
  17. Closures
  18. Best practices

<a name='gettingstarted'>Getting Started</a>

Install composer following this link

Local install

Then clone repository in local (path of our favorite editor) and install dependencies.

git clone git@github.com:naoned/php-convention.git
cd php-convention
composer install

Phpcs and phpmd binary are in vendor/bin directory.

One project

Add php-convention to your composer dependencies

composer require naoned/php-convention

Then add git hook script on scripts composer section

...

"scripts": {
    "post-install-cmd": [
        "Naoned\\PhpConvention\\GitHook::install"
    ],
    "post-update-cmd": [
        "Naoned\\PhpConvention\\GitHook::install"
    ]
},

<a name='ide'>IDE integration</a>

PHPStorm

Atom Editor

SublimeText

Install SublimeText Package Control

PHPCS PHPMD PHP_CS_FIXER

Ctrl+SHIFT+P > Install Package > Phpcs

Open user config file Preferences > Package Settings > PHP Code Sniffer > Settings - User

Then paste the following config and change PATH_TO_GIT_REPOSITORY

{
    "phpcs_execute_on_save": true,
    "phpcs_sniffer_run": true,
    "phpcs_command_on_save": true,
    "phpcs_show_quick_panel": true,
    "phpcs_executable_path": "{PATH_TO_GIT_REPOSITORY}/php-convention/vendor/bin/phpcs",
    "phpcs_additional_args": {
        "--standard": "{PATH_TO_GIT_REPOSITORY}/php-convention/phpcs/Iadvize/ruleset.xml",
        "-n": ""
    },
    "phpmd_run": true,
     "phpmd_executable_path": "{PATH_TO_GIT_REPOSITORY}/php-convention/vendor/bin/phpmd",
     "phpmd_additional_args": {
         "{PATH_TO_GIT_REPOSITORY}/php-convention/phpmd/phpmd.xml": ""
     },
    // @todo
    // "php_cs_fixer_executable_path": "/home/jbdelhommeau/workspace/php-convention/vendor/bin/php-cs-fixer",
    // "php_cs_fixer_additional_args": {
    //     "--fixers": "-pre_increment, trim_array_spaces, single_quote, return, newline_after_open_tag, multiline_spaces_before_semicolon"
    // }

}

<a name='files'>Files</a>

  • 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 <?php ?> tags for non-views scripts.

<?php

echo 'test';
  • Use the short-echo <?= ?> tags for view scripts.
<title><?=∙$title;∙?></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.

<a name='lines'>Lines</a>

  • Blank lines may be added to improve readability and to indicate related blocks of code.
// 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.
// bad
$foo = substr(strtoupper('test'), 0, 1);

// good
$foo = 'test';
$foo = strtoupper($foo);
$foo = substr($foo, 0, 1);

<a name='keywords'>Keywords</a>

  • All PHP keywords must be in lower case (Eg: true, false, null, etc.)

<a name='namespaces-use'>Namespaces and use declarations</a>

  • Namespaces names must be delcared in UpperCamelCase.
// 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:

// 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.
// 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;

<a name='comments'>Comments</a>

In-line code comments

  • Comments should be on a separate line immediately before the code line or block they reference.
// 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.
/**
 * 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();
/**
 * 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.
// Bad
namespace Vendor\Bar\Baz;

/**
 * Foo
 *
 */
class Foo
{
    /** @var \Other\MyClass $myClass */
    protected $myClass;

    /**
     * @return \Other\MyClass
     */
    public function getMyClass()
    {
      return $this->myClass;
    }
}
// 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.
/** @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
// 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
// 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();

<a name='naming'>Naming</a>

  • Clarity over brevity in variable, method and class names
// 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.
// 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.
// bad
$dateUpdate = new \DateTime;

// bad
$endDate = new \DateTime;

// good
$updatedAt = new \DateTime;

// good
$lastLoggedAt = new \DateTime;

<a name='variables'>Variables</a>

User variables

  • Variables should be in lowerCamelCase.
// bad
$_foo='';

// bad
$foo_bar = '';

// bad
$fooBar='';

// good
$fooBar∙=∙'';
  • You must set off operators with spaces.
// bad
$foo = (5+6)/5;

// good
$foo∙=∙(5∙+∙6)∙/∙5;
  • You must conserve a great alignment.
// bad
$foo = 'Ba';
$foo .= 'r';
$quux = 'Qu';
$quux .= 'x';

// good
$foo   = 'Ba';
$foo  .= 'r';
$quux  = 'Qu';
$quux .= 'x';
// 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.

<a name='strings'>Strings</a>

  • 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

$foo = 'Bar'
      .'Baz'
      .'Qux';
  • A string must not concatenate with functions or methods
// bad
$foo = ucfisrt('bar') . ' baz';

// good
$foo = ucfirst('bar');
$foo = $foo . ' baz';

// very good
$foo  = ucfirst('bar');
$foo .= ' baz';

<a name='type-casting'>Type casting</a>

  • 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).

// bad
$foo∙=∙(string)$bar;

// good
$foo∙=∙(string)∙$bar;

<a name='arrays'>Arrays</a>

  • You must use [] notation instead of array().

  • Arrays with few data must be declared like this:

$foo∙=∙['Bar',∙'Baz',∙'Qux'];
  • Arrays with lots of data must be declared like this:
$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)

<a name='classes'>Classes, Properties, and Methods</a>

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

namespace Vendor\Foo;

class Foo extends Bar implements Baz, Qux, Quux
{
    // Do something...
}
  • Lists of implements 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 interface per line.
<?php

namespace Vendor\Foo;

class Foo extends Bar implements
∙∙∙∙Baz,
∙∙∙∙Qux,
∙∙∙∙Quux
{
    // Do something...
}

Properties

  • Visibility must be declared on all properties.
// bad
/** @var string Property description */
$foo = '';

// good
/** @var string Property description */
public $foo = '';
  • There must not be more than one property declared per statement.
// bad
public $foo = '',
       $bar = '';

// good
/** @var string Property description */
public $foo = '';

/** @var string Property description */
protected $bar = '';
  • Property names must not be prefixed with a single underscore to indicate protected or private visibility.
// bad
/** @var string Property description */
protected $_bar = '';

/** @var string Property description */
private $_baz = '';

// good
/** @var string Property description */
protected $bar = '';

/** @var string Property description */
private $baz = '';
  • When present, the static declaration must come after the visibility declaration.
// bad
/** @var string $foo Property description */
static public $foo = '';

// good
/** @var string $foo Property description */
public static $foo = '';

Methods

  • Visibility must be declared on all methods. (Eg: public|protected|private foo())

  • Method names should not be prefixed with a single underscore to indicate protected or private visibility.

// bad
protected function _foo()
{
    // Do something...
}

// good
protected function foo()
{
    // Do something...
}
  • Method names must not be declared with a space after the method name.
// bad
public function foo∙()
{
    // Do something...
}

// good
public function foo()
{
    // Do something...
}
  • There must not be a space after the opening parenthesis, and there must not be a space before the closing parenthesis.
// bad
public function foo()∙{∙
    // Do something...
∙}

// good
public function foo()
{
    // Do something...
}
  • The opening brace must go on its own line, and the closing brace must go on the next line following the body.
// bad
public function foo()∙{
    // Do something...}

// good
public function foo()
{
    // Do something...
}
  • In the argument list, there must not be a space before each comma, and there must be one space after each comma.
// bad
public function foo($bar∙,∙&$baz∙,∙$qux = [])
{
    // Do something...
}

// bad
public function foo(∙$bar, &$baz, $qux = []∙)
{
    // Do something...
}

// good
public function foo($bar,∙&$baz,∙$qux∙=∙[])
{
    // Do something...
}
  • 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.

    • When the argument list is split across multiple lines, the closing parenthesis and opening brace must be placed together on their own line with one space between them.
// good
public function foo(
∙∙∙∙$bar,
∙∙∙∙&$baz,
∙∙∙∙$qux = []
) {
    // Do something...
}
  • When present, the abstract and final declarations must precede the visibility declaration.

  • When present, the static declaration must come after the visibility declaration.

// bad
protected abstract function foo();

static public final function bar()
{
    // Do something...
}

// good
abstract protected function foo();

final public static function bar()
{
    // Do something...
}

<a name='interfaces'>Interfaces, Traits</a>

Interfaces

  • The interface name must be suffixed with Interface.
<?php

namespace Vendor\Foo;

/**
 * Interface Foo
 *
 */
interface FooInterface
{
    /**
     * Set Foo
     *
     * @param string $foo
     */
    public function setFoo($foo);
}

Traits

  • The trait name must be suffixed with Trait.
<?php

namespace Vendor\Foo;

/**
 * Trait Foo
 *
 */
trait FooTrait
{
    /** @var \Vendor\Bar */
    protected $bar;

    /**
     * Set Bar
     *
     * @param string $bar
     */
    public function setBar($bar)
    {
        $this->bar = $bar;
    }
}

<a name='function-method-calls'>Function and Method Calls</a>

  • There must not be a space between the method or function name and the opening parenthesis.
// 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.
// 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.
// 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.
// 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.
// 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.
// bad
foo(
    [
        'foo' => 'bar',
    ]
);

// good
foo([
    'foo' => 'bar',
]);

<a name='control-structures'>Control structures</a>

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

// 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

// 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

// 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

// bad
while(EXPRESSION)
{
    // Do something...
}

// bad
do
{
    // Do something...
} while(EXPRESSION);

// good
while∙(EXPRESSION)∙{
∙∙∙∙// Do something...
}

// good
do∙{
∙∙∙∙// Do something...
}∙while∙(EXPRESSION);

for

Example

// bad
for( $i=0;$i<10;$i++ )
{
    // Do something...
}

// good
for∙($i∙=∙0;∙$i∙<∙10;∙$i++)∙{
∙∙∙∙// Do something...
}

foreach

Example

// bad
foreach( $foo as $key=>$value )
{
    // Do something...
}

// good
foreach∙($foo∙as∙$key∙=>∙$value)∙{
∙∙∙∙// Do something...
}

try and catch

Example

// 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...
}

<a name='closures'>Closures</a>

  • 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)

// 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)

$foo->bar(
∙∙∙∙$argumentFoo,
∙∙∙∙function∙($argumentBar)∙use∙($variableFoo)∙{
∙∙∙∙∙∙∙∙// Do something...
∙∙∙∙},
∙∙∙∙$argumentBaz
);

<a name='best-practices'>Best practices</a>

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.
// 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;

Credit

Inspired by iAdvize PHP Style Guide

Docker Pull Command
Owner
naoned
Source Repository

Comments (0)