Phalcon Coding Standard

    • Files must use only UTF-8 without BOM.
    • File names must be named StudlyCaps.
    • All files must use the Unix LF (linefeed) line ending.
    • All files must end with a single blank line.
    • Folders are also named StudlyCaps and the folder/subfolder tree follows the namespace of the class.
    3. use Phalcon\Acl\Adapter;
    5. class Memory extends Adapter
    6. {
    8. }
    • Code must use 4 spaces for indenting, not tabs.
    • Lines should be 80 characters or less. The hard limit on line length is 120 characters.
    • There must not be trailing whitespace at the end of non-blank lines.
    • Blank lines may be added to improve readability and to indicate related blocks of code.
    • There must not be more than one statement per line.

    Classes

    • Class names must be declared in StudlyCaps.
    • Opening braces for classes must go on the next line, and closing braces must go on the next line after the body.
    • Abstract classes must be prefixed by Abstract
    • Interfaces must be suffixed by Interface
    • Class constants must be declared in all upper case with underscore separators.
    • Class constants must appear at the top of the class.
    • Class constants must be sorted alphabetically by constant name.
    • Class properties must be declared in camelCase.
    • Class properties must be sorted alphabetically based on name.
    • Whenever possible, properties must have a default value.
    • Whenever possible, properties must have a docblock that defines their type with the @var declaration.
    • Properties must not be prefixed with underscore _. The only exception is if the property name is a reserved keyword such as default, etc.
    1. namespace Phalcon\Acl\Adapter;
    3. use Phalcon\Acl\Adapter;
    5. class Memory extends Adapter
    6. {
    7.      * Returns latest key used to acquire access
    8.      *
    9.      * @var string | null
    10.      */
    11.     protected activeKey = "" { get };
    • Method names must be declared in camelCase.
    • Methods must be sorted alphabetically based on their visibility. The order is public, protected and private. __construct if defined must be at the top of the class.
    • Method names must not be prefixed with underscore _.
    • All methods must have a return type. If the method does not return anything it should be marked void
    • 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.
    • 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.
    • Control structures such as if must not have parentheses around the conditional, unless it is a complex one.
    1. if typeof variable === "array" {
    • In the argument list, there must not be a space before each comma, and there must be one space after each comma.
    • Each method must have its type declared before it
    • Method arguments with default values must go at the end of the argument list.