Estándar de Código de Phalcon

Última actualización: 04-07-2019

Phalcon is written in Zephir, a language that the Phalcon Team invented and is actively developing. Por ello, aunque los desarrolladores quisieran seguirlo, no hay todavía ningún estándar de código establecido.

En este documento se describe el estándar de código que utiliza Phalcon para editar archivos de Zephir. The coding standard is a variant of PSR-12 developed by PHP-FIG

Archivos

Los archivos deben usar solo UTF-8 sin BOM (marca de orden de bytes).
Los nombres de los archivos deben estar en formato StudlyCaps.
Todos los archivos deben usar el final de línea de Unix LF (linefeed).
Todos los archivos deben terminar con una única línea en blanco.
Folders are also named StudlyCaps and the folder/sub-folder tree follows the namespace of the class.

phalcon/Acl/Adapter/Memory.zep

namespace Phalcon\Acl\Adapter;

use Phalcon\Acl\Adapter;

class Memory extends Adapter
{

}

El código debe utilizar 4 espacios para la sangría, no tabulaciones.
Lines should be 80 characters or fewer. El límite de la longitud de línea es de 120 caracteres.
Debe haber una línea en blanco después del espacio de nombres. También debe haber una línea en blanco después del bloque de declaraciones.
No debe haber espacios en blanco al final de las líneas con código.
Se pueden agregar líneas en blanco para hacer más legible el código o para indicar bloques de código relacionados.
No debe haber más de una declaración por línea.

Clases

Los nombres de las clases deben estar en formato StudlyCaps.
La llave de apertura de las clases debe ir en la línea siguiente a la declaración, y la de cierre en la línea siguiente del cuerpo.
Las clases abstractas deben tener el prefijo Abstract
Las interfaces deben tener el sufijo Interface

Constantes

Las constantes de clase deben declararse en mayúscula utilizando el guion bajo como separador.
Las constantes de clase deben aparecer en la parte superior.
Las constantes de clase deben estar en orden alfabético.

namespace Phalcon\Acl;

class Enum
{
    const ALLOW = 1;
    const DENY  = 0;
}

Propiedades

Las propiedades de clase deben ser declaradas en formato camelCase.
Las propiedades de clase deben estar en orden alfabético.
Siempre que sea posible, las propiedades deben tener un valor predeterminado.
Siempre que sea posible, las propiedades deben tener un bloque de documentación (docblock) que defina su tipo mediante la declaración @var.
Las propiedades no deben usar como prefijo un guion bajo _. La única excepción es si el nombre de la propiedad es una palabra reservada como default, namespace, etc.

namespace Phalcon\Acl\Adapter;

use Phalcon\Acl\Adapter;

class Memory extends Adapter
{
    /**
     * @var string | null
     */
    protected activeKey = "" { get };
}

Métodos

Los nombres de los métodos deben ser declarados en formato camelCase.
Los métodos deben estar en orden alfabético según su visibilidad. El orden es public, protected y private. Si se define __construct debe aparecer al principio de la clase.
Los nombres de los métodos no deben usar como prefijo un guion bajo _.
Todos los métodos deben devolver un tipo. Si el método no devuelve nada entonces debe ser marcado como void.
La llave de apertura de los métodos debe ir en la línea siguiente a la declaración, y la de cierre en la línea siguiente del cuerpo.
En todas las propiedades y métodos se debe declarar su visibilidad; abstract y final deben declararse antes de la misma; static, después.

abstract public function getElement() -> var;

final public function getElement() -> var;

public static function getElement() -> var;

Después de las palabras clave (keywords) de las estructuras de control debe haber un espacio en blanco; después de las llamadas a métodos y funciones, no.
La llave de apertura de las estructuras de control debe ir en la misma línea, y la de cierre en la línea siguiente del cuerpo.
Las estructuras de control como if no deben tener la condición entre paréntesis, salvo que sea compleja.

if typeof variable === "array" {

}

Argumentos de los métodos

En la lista de argumentos no debe haber un espacio en blanco antes de cada coma, pero sí después de cada una de ellas.
El tipo de cada método debe declararse al principio.
Los argumentos de los métodos con valores predeterminados deben ir al final de la lista de argumentos.

public function setElement(string! name, var value) -> void;

La lista de argumentos se puede dividir en múltiples líneas, cada una con su respectiva sangría. Al hacerlo así, el primer elemento de la lista debe estar en la línea siguiente, y solo debe haber un argumento por línea.