Nomenclatura de elementos en Drupal
- Área: Codificación y construcción en Drupal
- Tipo de pauta: Directriz
- Carácter de la pauta: Obligatoria
Los nombres de las funciones, módulos y ficheros en Drupal deben seguir unas convenciones para facilitar su estandarización.
A continuación se van a ofrecer una serie de pautas para estandarizar los elementos que se utilizan en Drupal
Pautas
Título | Carácter |
---|---|
Nombre de las funciones | Obligatoria |
Nombre de los módulos | Obligatoria |
Nombre de los ficheros | Obligatoria |
Nombre de las funciones
Los nombres de las funciones en Drupal estarán en minúsculas y basado en el nombre del módulo del que forma parte. Los guiones bajos se utilizan para separar las palabras descriptivas del nombre. Después del nombre del módulo, la función debe nombrarse con el verbo y el objeto a los que atañe.
Incorrecto
function some_text_munge() {
...
}
Correcto
function mymodule_munge_some_text() {
...
}
Las funciones de tipo privadas siguen esta convención pero empiezan por un guión bajo.
Nombre de los módulos
El nombre de un módulo no debe contener guiones bajos para evitar conflictos de espacios de nombres. Pongamos un ejemplo, un desarrollador crea node_list.module que contiene una función node_list_all(). En la siguiente versión de drupal, el modulo node perteneciente al core de drupal incluye una función node_list_all(), ya tendríamos el conflicto asegurado
Un conflicto en el espacio de nombres por un módulo contribuido significa trabajo extra para el desarrollador y para cualquier persona que ha escrito el código que depende de su módulo.
Nombre de los ficheros
Los nombres de los ficheros deben de ser en minúsculas. La excepción es para los ficheros de documentación, que deben de ser todo en mayúsculas y con la terminación .txt:
CHANGELOG.txt
INSTALL.txt
README.txt