Lenguaje y Normas de Desarrollo
He aquí algunas normas sobre el lenguaje, la sintaxis y las norma de desarrollo en vigor para el proyecto Dolibarr:
Versiones
- Dolibarr debe funcionar con:
- Todos los SO (Windows, Linux, MACOS...)
- PHP 7.1.0+ (Debe funcionar sin ningún módulo PHP complementario, exceptuando los módulos de acceso a la base de datos).
- Mysql 5.1+
Normas de Copyright
- Todos los archivos PHP deben empezar con una cabezara como
<?php
/* Copyright (C) YYYY John Doe <email@email.com>
*
* Licence information
*/
...
Si edita un archivo existente del proyecto, debe añadir una línea de Copyright debajo de las otras.
Normas PHP
- Dolibarr está escrito en PHP y soporta todas las versiones de PHP superiores a la 7.1.0+. Todos los archivos deben de contener la extensión .php
- La llamada a las variables superglobales PHP deben pasar a través de los operadores dedicados $_COOKIE, $_SERVER, $_ENV y a través de la función dolibarr GETPOST() para obtener el contenido de$_GET o $_POST...
Los otros operadores ($HTTP_SERVER_GET, ...) están siendo depreciados en el seno de PHP, no deben de ser ya utilizados. Por lo tanto, el código debe funcionar incluso cuando la opción register_long_arrays esté en off. Además de que el código debe funcionar cuando la opción de PHP register_globals esté en off (recomendado por PHP), también lo deberá hacer cuando la opción register_globals esté en on (por defecto en muchas instalaciones).
- Los smart tags PHP no són utilizados. Las secciones de código deben de empezar por <?php
- No se permite el uso de la variable PHP_SELF. Utilice en su lugar $_SERVER["PHP_SELF"]
- Cuando varias variables deben ser inicializadas con el mismo valor, utilice múltiples líneas
$var1 = 1; $var2 = 1; $var3 = 1;
en lugar de
$var1 = $var2 = $var3 = 1;
que es menos eficiente.
- las cadenas deben de ser con las variables sacadas de la cadena.
print "Mi texo muestra mi ".$variable." !\n";
- Los comentarios deben seguir la sintaxis de C, es decir, una doble barra invertida para una línea de comentario y el uso de una barra con arterisco para abrir un bloque de varias líneas
/* Bloque de comentarios
*
* Fin el bloque
*/
$monobjet = new MonObjet($db);
$result=$monobjet->fetch($idobject);
for ($i = 1 , $i < 2 ; $i++)
{
// comentario de una línea
print $i;
}
- Los ficheros deben ser guardados en formato Unix (LF) y no en formato Windows (CR/LF). El formato Unix es compatible con los SO Unix, Windows, Mac, mientras que el formato de archivo de texto de Windows es problemático en algunos PHP en Unix.
- Las funciones deben devolver >0 en caso de éxito, y un número <0 en caso de error.
- Sin código muerto (no usado) en el código principal de Dolibarr (El código usado únicamente por un módulo externo debe ser incluido en el módulo externo).
- Usar "include_once" para la inclusión de todo archivo que contenga definiciones de funciones o de clases (archivos *.class.php y *.lib.php), usar "include" para la inclusión de archivos de tipo template o que contenga una mezcla de HTML y PHP (archivos *.inc.php et *.tpl.php).
- Ejemplo de nombre de Campos php:
- entity that is id for the multicompany feature - date_creation: date of creation - date_modification: date of last modification (often field tms in database) - date_validation: date validation - fk_user_creation: id of User of creation - fk_user_modification: id of User of last modification - fk_user_validation: id of User of validation - import_key contains the import code YYYYMMDDHHMMSS, if record was loaded with a mass import.
Normas SQL
Estructura de Tabla
- Todas las tablas tienen prefijo para evitar conflictos de nombres. A día de hoy, el prefijo está determinado y no se puede cambiar. Su valor es llx_. Sin embargo, está pendiente de considerar, en una futura versión, el poder cambiarlo en el momento de la instalación.
- En la práctica, con la finalidad de set compatible con todas las precisiones de los paises, utilizaremos los siguientes tipos:
- integer para cualquier foreign key - double(24,8) para cualquier importe - double(6,3) para las tasas de IVA - real para una cantidad - varchar para una cadena (incluidos los de longitud 1, el tipo char se está depreciando) - timestamp para fecha+hora que deba ser actualizado automáticamente - datetime para fecha+hora - date para fecha
Clave primaria
La clave primaria de una tbla se llama rowid.
Hay unas pocas tablas que incumplen la norma ahora (ej Table llx_c_actioncomm), por razones históricas. Podrá ser estudiada una evolución para una próxima versión.
Clave secundaria
El nombre de una clave secundaria empieza con el prefijo fk_ seguido por el nombre de la tabla vinculada (necesario para evitar duplicaciones globales en la base de datos, problemáticas en algunos RDBMS como postgresql), seguido del campo vinculado (para permitir diferentes claves secundarias en la misma tabla).
Ejemplo: fk_facture_fourn_fk_soc
Clave alternativa
A veces no sólamente la clave primaria debe ser única. Por lo tanto, podemos añadir un índice de clave única alternativa. Este índice es llamado por un nombre que comienza con el prefijo uk_ seguido por el nombre de la tabla (necesario para evitar la duplicación de índeces globales en la base de datos, problemáticos en algunos DBMS como postgresql) y de un sufijo que caracterice a la clave (para permitir múltiples índices en una sola tabla).
Ejemplo: uk_societe_code_client
Indices de rendimiento
Algunos campos se utilizan a menudo como un criterio para la búsqueda, clasificación o afiliación. Conviene en este caso, poner un índice de rendimiento. Tales índices se llamarán con un prefijo idx_ seguidos del nombre de la tabla y el nombre del campo en el que el índice trabaja.
Ejemplo: idx_societe_user_creat
Formato de fichero DDL
Los ficheros que contienen la definición de la estructura de la base de datos (DDL) deben de estar repartidos en dos tablas:
- Cada tabla se define en su propio archivo cuyo nombre es llx_mitabla.sql
Donde habrá un comentario junto a cada campo para explicar su significado.
- Claves de relacionales y el índice de rendimiento o otras constraints de carácter único se definen en un archivo cuyo nombre es llx_mitable.key.sql
Estos ficheros se guardan el la carpeta install/mysql/tables para los ficheros standards ó mimodulo/tables para las tablas llevadas por un módulo.
Ejemplos Fichero tabla llx_matable.sql:
-- ===========================================================================
-- Copyright (C) 2008 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================
create table llx_matable
(
rowid integer AUTO_INCREMENT PRIMARY KEY,
field_one integer,
field_two integer NOT NULL,
fk_field integer,
field_date datetime,
tms timestamp
)type=innodb;
Ejemplos Fichero de claves/índices llx_matable.key.sql
-- ===========================================================================
-- Copyright (C) 2008 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================
ALTER TABLE llx_matable ADD UNIQUE uk_matable_field(field_one, field_two);
ALTER TABLE llx_matable ADD CONSTRAINT fk_matable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
SQL Coding rules
- Uso de alias / nombres de los campos
Dentro de los selects pueden utilizar alias para simplificar la redacción de las consultas:
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
Sin embargo, no debemos utilizar este alias en las consultas de actualización porque no es compatible con mysql 3.1.
- ¡Los SELECT * están prohibidos! Cada Select deberá especificar la lista completa de los campos para recuperar. Esto permitirá evitar confusiones. Ejemplo:
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
- En las consultas SQL, entrecomillaremos los campos, pero no los numéricos que contengan cantidades que se almacenen en los campos de tipo double o real. Los entrecomillados en los numéricos de tipo float se almacenan con un valor diferente. Por ejemplo 412.62 dentro del insert se guardara con el valor 412.61999512 en base si el campo es de tipo double(24,8). Y PHP sólo ve 412.61999512. Otras herramientas verán 412.62 dando la impresión de que no hay problemas. Y PHP tiene razón, hay un problema en base. Mediante la eliminación de las comillas en los numéricos, esto irá mejor.
Ejemplo:
Bien:INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
Mal: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
Nota, el problema de los float es general y no sólamete en el acceso a la base de datos, está presente en todos los lenguajes cuando trabajamos sobre números reales, por lo que deberán ser limpiados por la función price2num con el segundo parámetro rellenado con: 'MU', 'MT' ó 'MS' según sea necesario. Consulte el capítulo "Los números reales, importes y cálculos" más abajo.
- las funciones NOW, SYSDATE ó IFNULL están prohibidas en las órdenes de SQL. Si se necesita indicar la fecha del momento en un campo, el valor debe provenir de PHP y no del motor de la base de datos. Esto además de ofrecer una mejor portabilidad del código, también permite una gestión correcta de la zona horaria.
Reglas de migración de base de datos
- Los scripts de migración de estructura se encuentran en el directorio install/mysql/migration/a.b.c-x.y.z.sql. En un archivo de migración de n a n+1, no destruiremos una tabla (DROP TABLE) que no sea utilizada en n+1, se realizará en la migración de la versión n+1 a n+2. Esto tiene el fin de conservar las tablas depreciadas durante una versión para poder reparar una situación de error de migración.
Particularidades de MySQL
- Las tablas deben de estar en formato InnoDB.
En efecto, este formato soporta claves secundarias, las eventuales restricciones que se adjuntan y la noción de integridad de transacciones requeridas para obteter datos coherentes entre tablas en la base de datos.
- Dolibarr debe trabajar incluso con la opción strict de Mysql activa.
Para activarla, añada la siguiente línea en su archivo config del servidor MySql (my.cnf o my.ini)
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
Particularidades de PostgreSQL
Sólo los archivos de MySQL deben mantenerse. Los archivos para otras bases de datos se convierten "al vuelo" por el gestor de la base de datos.
Normas HTML
- Todos los atributos de las etiquetas HTML deben de estar *en minúscula* y entrecomillados con *doble comilla*.
- Los enlaces href deben de ser absolutos. para las páginas, basarse en la function dol_buildpath(). Para las imágenes basarse en la llamada de la función img_picto.
Por ejemplo:
print '<a href="'.dol_buildpath('/monrep/mapage.php').'">'.img_picto('Texte alt','nompictopng','').'</a>';
- Las tablas HTML deben tener las columnas sin valores forcados, a excepción de las columnas que contienen información cuya longitud no es variable. Por ejemplo, una columna con una imagen puede forzarse a un with="20px". En los otros casos, hay que evitar forzar la longitud de las columnas. Esto es porque en la mayoría de los casos el navegador realiza un buen trabajo al definir automáticamente la longitud de las columnas, independientemente de la resolución de la pantalla.
- Javascript/ajax y la llamada a scripts java en las páginas php está fuera de las normas. Si de todas maneras se incluye código javascript, debe estar condicionado mediante el test "$conf->use_javascript_ajax"
if ($conf->use_javascript_ajax) {
... // El código PHP que genera el javascript va aquí
}
- Las ventanas emergentes no deben de ser utilizadas, exceptuando los tooltips (y quedan condicionados por el punto anterior).
- Los scripts externos son escritos en Perl si no pueden serlo en php, la utilización de otro lenguaje no está prohibido, pero debe de ser discutido priero en la lista de correo de desarrollo.
Normas Dolibarr y plantillas de código
Plantillas de código
Para estandarizar el código y acelerar el desarrollo de nuevos componentes en Dolibarr, en la carpeta htdocs/modulebuilder/templates encontraremos plantillas de código preparadas.
- 1 que sirve de ejemplo de descriptor de módulo: myModule.class.php
- 1 que sirve de ejemplo de código para crear una nueva clase: skeleton_class.class.php
- 1 que sirve de ejemplo de código para crear una nueva página: skeleton_page.php
- 1 que sirve de ejemplo de código para crear una nuevo script a ejecutar en línea de comandos: skeleton_script.php
Úsenlas como ejemplo. Tenga en cuenta que estas plantillas también son utilizadas por el generador de código PHP que se describe en el capítulo de Desarrollo de módulos Dolibarr módulo para acelerar su desarrollo.
Las fechas y la Zona Horaria
Dolibarr es una aplicación multi-usuario y multi-ubicación. Por lo tanto, es necesario almacenar las fechas en el formato correcto. Para evitar problemas de conversión, deben aplicarse las siguientes reglas:
- Una fecha en memoria debe de estar en formato Timestamp GMT.
- Una fecha guardada en la base de datos contiene el Timestamp GMT en relación con la fecha que figura en la consulta en hora local del servidor PHP. No se trata de las fechas de actualización de la base de datos (campo tms en la base de datos).
Por lo tanto, el 1 de enero de 1970, a las 3 en París (TZ=+1) = las 2 en Greenwitch (TZ=0) será almacenado en memoria 7200 y será enviado a la base de datos con la cadena '19700101030000' (PHP convierte en hora de su TZ y la base de datos la de-convierte con su TZ que es la misma que la de PHP).
Los métodos select deben traducir los campos fecha al formato de cadena TZ de la base ('19700101030000') mediante la llamada del método db->jdate para recuperar la información en memoria en formato Timestamp GMT. Y los métodos insert deben deben generar la petición convirtiendo la fecha en memoria conocida en variable, mediante el método db->idate (Ver ejemplos generados por la plantilla).
- Las actualizaciones automáticas de la base de datos (campo tms en la base) contienen el Timestamp GMT del momento en que se ha realizado la modificación. Los métodos select recuperan directamente este dato en memoria en formato Timestamp GMT.
- La manipulación de fechas en PHP debe realizarse usando las funciones de fechas de Dolibarr: dol_now(), dol_mktime(), dol_stringtotime(), dol_getdate(), dol_time_plus_duree(). También se encuentran otras funciones listas para su uso en el archivo date.lib.php.
Codificación UTF8/ISO
Dolibarr guarda la información de la manera siguiente:
- En la base de datos, los datos en UTF8 ó ISO. Esto depende del pagecode de la base de datos, y por lo tanto, de las opciones en la creación de esta base de datos. En todos los casos, el controlador de base de datos Dolibarr (dentro de /lib/database) lee e inserta por conversión desde y hacia UTF8.
- Los datos en memoria se guardan en UTF8 (instancias de objetos PHP).
- las páginas web mostradas en pantalla se encuentran en formato UTF8 (con versiones < 2.5.1, es el antiguo parámetro $character_set del fichero conf.php quien define el formato de salida).
Los números reales, importes y cálculos
Tanto en PHP como en otros lenguajes (Java, por ejemplo), los datos no enteros (float, real, double) no son fialbes. Pruebe a realizar por ejemplo
print 239.2 - 229.3 - 9.9;
No obtendrá 0, sino un número muy pequeño en potencia 10 negativo . Si obtiene cero, puede encontrar otros ejemplos que no funcionan. El problema de los float es general, una variable resultante del cálculo de números reales debe SISTEMATICAMENTE ser limpiada mediante la función price2num() con el segundo parámetro rellenado con: 'MU', 'MT' ó 'MS' según el caso (ver doc de la función).
print price2num(239.2 - 229.3 - 9.9, 'MT');
Si no es un precio que se ajuste a los parámetros de MU, MT, MS debe utilizar la función round().
Creación de tablas
No crear una tabla a utilizar, es decir, al primer uso del módulo. Si crea un módulo que usa tablas que no se incluyen como estándar en el código de Dolibarr, asegúrese de seguir el tutorial Creación de un módulo que explica cómo incluir las tablas que se crean en la activación del módulo y no en su uso (ver más arriba).
Logs
Añada traces dentro de su código mediante la función
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
Carpetas de trabajo
Si tiene que crear una carpeta de trabajo, en el código, haga referencia a esta carpeta de la siguiente forma DOL_DATA_ROOT.'/mimodulo'
La carpeta puede crearse en desde su código mediante el código siguiente:
$mymoduledir=DOL_DATA_ROOT.'/mimodulo';
dol_mkdir($mymoduledir);
Si necesita una carpeta de datos temporales, esta carpeta deberá ser DOL_DATA_ROOT.'/minmodulo/temp'
Patrones de Diseño y programación con objetos
Patrones de Diseño Creacionales (GoF)
Design patterns definidos por el le Gang Of Four (ver la wikipedia sobre los Design patterns). No hay design patterns creacionales particulares. Hay objetos cercanos a los Singleton y creados conforme al 100% en el espíritu, pero no en la sintaxis, a fin de ser compatible con PHP 4 que no es un lenguaje orientado a objetos completo.
Design patterns Estructurales (GoF)
(ver la wikipedia sobre los Design patterns). No hay design patterns estructurales particulares.
Design patterns de Comportamiento (GoF)
(ver la wikipedia sobre los Design patterns). No hay design patterns de Comportamiento particulares.
Design patterns enterprise (Martin Fowler)
Motivos de organización del código
Martin Fowler ha identificado 3 métodos de organización de código llamados principios:
- El Transaction Script (El código es lineal en función de una acción del usuario).
Es el antiguo principio utilizado en los lenguajes de procedimiento. Inconveniente: Redundancia de código. Necesidad de conocer el modelo físico a desarrollar.
- El Domain Model
Es un modelo posible desde los lenguajes orientados a objeto. Son procedimentos funcionales (que deben de ser indentificados antes) que sirven de base para las clases objeto. Inconveniente: Motivo de mantenimiento complejo.
- El Table Module
Un intermedio entre los 2 anteriores donde se tiene una sola clase por tabla de la base de datos.
-> Como se muestra en el código de la plantilla (ver sección anterior) Dolibarr se basa en el principio de Table Module.
Comunicación lógica de negociado - datos (ORM)
Existen 3 tipos de conexiones:
- Data Gateway a tablas y filas
Es el más simple. Creamos una tabla por clase y cada clase es un puente con la tabla correspondiente, ver una clase por línea tabla. Una instancia de la clase será pues un registro de la tabla. La clase contiene sólo el código de acceso a líneas o columnas de tablas.
Ejemplo: Es el método utilizado al utilizar ciertos Frameworks de ORM como iBatis (http://ibatis.apache.org/).
- El Active Record
Idéntico al anterior, pero podemos añadir algunas funciones de negociado en la clase, siempre que estas funciones sean exclusivas de la tabla o la grabación.
Ejemplo: Es el método utilizado por los desarrollos de Dolibarr y por otras muchas aplicaciones en PHP que disponen de su propio propio framework y prácticas de desarrollo.
- El Data Mapper
Las clases representan las entidades del problema y no los datos. Por lo tanto hay que doblar, triplicar... estas clases con clases de mapeo para acceder a los datos. Más "purista" en el papel ya que el negociado está más cercano, este método también tiene la desventaja de ser más complejo en la práctica.
Ejemplo: Es el utilizadao si utilizamos el Framework de ORM Propel (https://propelorm.org/). Lo encontraremos pues en aplicacciones más pesadas basadas en este ORM.
-> Para los desarrollos de Dolibarr, es recomendado utilizar el modo Active Record que ofrece las ventajas de un modelo cercano de negociado sin la complejidad y sin dificultar mucho la técnica. Es en este modo mediante el cual el desarrollo, la comprensión del código y el mantenimiento técnico y/o funcional parece ser la más productivo (Sin embargo, se trata de un eterno debate entre los puristas y los pragmáticos, el debate en el que nadie puede realmente estar en lo cierto, porque todo depende de los objetivos a atender).