Coding standards PSR-1 & PSR-2

Coding Standards by Aram Baghdasaryan
Coding Standards
PSR-1 & PSR-2

PHP Standards Recommendation
What is PSR?

PSR-0 - Autoloader Standard
What is PSR?

PSR-1 - Basic Coding Standard
What is PSR?

PSR-2 - Coding Style Guide
What is PSR?

PSR-3 - Logger Interface
What is PSR?

Single style guide for PHP code that results
in uniformly formatted shared code
What it gives to us?

· Files MUST use only <?php and <?= tags
· Files MUST use only UTF-8 without BOM for
PHP code.
· Files SHOULD either declare symbols or cause
side-effects but SHOULD NOT do both
PSR-1 Overview

Files SHOULD either declare
symbols or cause side-effects
but SHOULD NOT do both

// side effect: change ini settings
ini_set('error_reporting', E_ALL);
// side effect: loads a file
include "file.php";
Files SHOULD either declare
symbols or cause side-effects
but SHOULD NOT do both

· Namespaces and classes MUST follow an
"autoloading" PSR
· Class names MUST be declared in StudlyCaps
· Class constants MUST be declared in all upper
case with underscore separators.
· Method names MUST be declared in camelCase
PSR-1 Overview

· Code MUST follow a "coding style guide" PSR-1
· Code MUST use 4 spaces for indenting, not tabs
· There MUST NOT be a hard limit on line length,
the soft limit MUST be 120 characters, lines
SHOULD be 80 characters or less
PSR-2 Overview

· There MUST be one blank line after the
namespace declaration, and there MUST be one
blank line after the block of use declarations
· Opening braces for classes MUST go on the next
line, and closing braces MUST go on the next line
after the body
PSR-2 Overview

<?php
namespace App;
use VendorLib1Tool;
use VendorLib2Tool;
class BloBlo {
...
}

· Opening braces for methods MUST go on the
next line, and closing braces MUST go on the
next line after the body
· Visibility MUST be declared on all properties
and methods, abstract and final MUST be
declared before the visibility, static MUST be
declared after the visibility
PSR-2 Overview

final public static function getBlo()
{
...
}

· Control structure keywords MUST have one
space after them, method and function calls
MUST NOT
· Opening braces for control structures MUST go
on the same line, and closing braces MUST go on
the next line after the body
PSR-2 Overview

· Opening parentheses for control structures
MUST NOT have a space after them, and closing
parentheses for control structures MUST NOT
have a space before
PSR-2 Overview

function getBlo($param) use ($other)
{
if (true) {
...
}
}
getBlo(‘value’);

Other Examples

function aLongMethodName(
ClassTypeHint $arg1,
&$arg2,
array $arg3 = []
) {
// method body
}

$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);

if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body
}

switch ($expr) {
case 0:
echo 'First case, with a break';
break;
case 2:
case 3:
echo 'Third case';
return;
default:
echo 'Default case';
}

while ($expr) {
// structure body
}
do {
// structure body;
} while ($expr);

for ($i = 0; $i < 10; $i++) {
// for body
}
foreach ($iterable as $key => $value) {
// foreach body
}

try {
// try body
} catch (FirstExceptionType $e) {
// catch body
} catch (OtherExceptionType $e) {
// catch body
}

$closure = function ($arg1, $arg2) {
// body
};
$closure = function ($arg1) use ($var1) {
// body
};

Thank You!

Coding standards PSR-1 & PSR-2

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (20)

Destacado

Destacado (17)

Último

Último (20)

Coding standards PSR-1 & PSR-2