Se encuentra en:
Nomenclatura de elementos en PHP
LIBP-0090 (Libro de pautas)
- Área: Reglas Generales de Construcción de Aplicaciones PHP
- Tipo de pauta: Directriz
- Carácter de la pauta: Obligatoria
A continuación se van a ofrecer una serie de pautas para establecer una estandarización de los elementos utilizados en la programación basada en php.
Pautas
| Título | Carácter |
|---|---|
| Clases | Obligatoria |
| Clases Abstractas | Obligatoria |
| Interfaces | Obligatoria |
| Nombre de ficheros | Obligatoria |
| Funciones y Métodos | Obligatoria |
| Variables | Obligatoria |
| Constantes | Obligatoria |
Clases
Los nombres de clases solo pueden contener caracteres alfanuméricos. Se desaconseja el uso de número dentro de la nomenclatura de clases. Si se utiliza mas de una palabra para el nombre de una clase, es necesario poner en mayúscula la primera letra de cada palabra. El resto de las letras no pueden indicarse en mayúsculas.
La clase "Documento_PDF" no esta permitida
La clase "Documento_Pdf" esta permitida
Clases Abstractas
En general, las clases abstractas siguen las mismas consideraciones que las clases , pero con una regla adicional. Las clases abstractas deben de terminar con la palabra "Abstract". Este sufijo no puede ir precedido de un guión bajo.
La clase Zend_Controller_Plugin_Abstract es considerada como invalidad
La clase Zend_Controller_PluginAbstract sería valida.
Interfaces
En general, las interfaces siguen la misma convención que las clases con la única regla adicional de que las Interfaces deben de finalizar con la palabra "Interface". Este sufijo no puede ir precedido de un guión bajo.
La interfaz Zend_Controller_Plugin_Interface es considerada no valida
La interfaz Zend_Controller_PluginInterface es considerada como valida
Nombre de ficheros
Funciones y Métodos
Los nombres de las funciones solo pueden contener caracteres alfanuméricos. Los guiones bajos no están permitidos y el uso de los números es desaconsejable. Las funciones siempre comienzan en minúsculas. Si una función tiene mas de una palabra, cada palabra a excepción de la primera debe de comenzar en mayúsculas. Es recomendable dar un nombre a la función que describa su funcionalidad y su comportamiento
// Ejemplos de funciones
filterInput()
getElementById()
widgetFactory()
Variables
Los nombres de las variables solo pueden contener caracteres alfanuméricos. Los guiones bajos no están permitidos y el uso de los números es desaconsejable.
Para las variables que son declaradas con el modificador "private" o "protected", el primer carácter debe de ser un simple guion bajo. Las variables declaradas como publicas nunca comenzaran con guion bajo. Las variables siempre comenzaran con una letra en minúscula.
Constantes
Las constantes pueden contener tanto caracteres alfanuméricos como guiones bajo. Los números son permitidos en los nombres de las constantes. Todas las letras que se utilizan en una constante deben de ir en mayúscula, y las palabras separadas por guiones bajos
La constantes EMBED_SUPPRESS_EMBED_EXCEPTION esta permitida,
mientras que la constante EMBED_SUPPRESSEMBEDEXCEPTION no esta permitida
