4,395
edits
Desarrollo de un módulo: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
|||
| Line 11: | Line 11: | ||
etc. Todas estas operaciones sólo están disponibles a partir de la versión 2.4 de Dolibarr. | etc. Todas estas operaciones sólo están disponibles a partir de la versión 2.4 de Dolibarr. | ||
Los capítulos siguientes describen cómo hacer todo esto manualmente de manera sencilla. Para los desarrolladores experimentados, se está desarrollando un método de generación de MDA.Véase el último capítulo para consultar. | |||
| Line 16: | Line 18: | ||
'''Cuándo''': Obligatorio cada vez que se desarrolla una extensión, cualquiera que sea su finalidad. | '''Cuándo''': Obligatorio cada vez que se desarrolla una extensión, cualquiera que sea su finalidad. | ||
== Crear | == Crear su descriptor == | ||
La primera fase es la de crear un fichero descriptor del módulo. Para ello, | La primera fase es la de crear un fichero descriptor del módulo. Para ello, vaya al directorio '''dev/skeletons''' y copie el archivo "modMyModule.class.php" en el directorio '''htdocs/includes/modules'''. A continuación, modifique el contenido de este archivo con el fin de reemplazar: | ||
* los "modMyModule" por un valor que corresponda a la finalidad de | * los "modMyModule" por un valor que corresponda a la finalidad de su módulo. Este valor debe siempre comenzar por mod. | ||
* $this->numero = 10000 por un número de módulo que esté libre (Para saber qué números ya están siendo utilizados, vaya a la página "'''Inicio-> Info sistema-> Dolibarr-> Módulos'''") | * $this->numero = 10000 por un número de módulo que esté libre (Para saber qué números ya están siendo utilizados, vaya a la página "'''Inicio-> Info sistema-> Dolibarr-> Módulos'''") | ||
* Modificar eventualmente otras variables definidas por los desarrolladores (ver el comentario en el código del esqueleto para ver su significado) | * Modificar eventualmente otras variables definidas por los desarrolladores (ver el comentario en el código del esqueleto para ver su significado) | ||
* Crear | * Crear el directorio /htdocs/mimodulo/ | ||
Ahora | Ahora su fichero descriptor está configurado. | ||
= | == Probar su descriptor == | ||
Ejecute Dolibarr y vaya a la página "Configuración > Módulo". Debería aparecer una nueva línea con su nuevo módulo y la posibilidad de activarlo o no (eche un vistazo a todas las pestañas de cada categoría para encontrarlo). Es el valor $this->special el que determina en qué pestaña se encuentra su módulo. | |||
= [[File:Art.png]] Crear su tablas SQL y la clase PHP de los métodos de acceso (opcional) = | |||
'''Cuándo:''' Si su módulo necesita gestionar sus propios datos. | |||
==Crear sus ficheros .sql== | |||
Si su módulo de verdad requiere administrar datos que no existen en la base de datos en la versión estándar de Dolibarr, será necesario definir ciertas tablas SQL para registrar esos datos. | |||
Cree un subdirectorio sql en el directorio de su módulo (por ejemplo, htdocs/mimodulo/sql), con el fin de colocar los scripts sql que va a crear. | |||
por | |||
''Regla a respetar:'' | ''Regla a respetar:'' | ||
* | * Agregue los archivos de orden de creación de sus tablas siguiendo el principio de un fichero '''llx_mitabla.sql'' por tabla, eventualmente acompañado del archivo '''llx_mitabla.key.sql''' (ver los archivos existentes en ''includes/mysql/tables'', para tomar ejemplo). | ||
* En términos de orden de gestión de datos, todos deben estar en un archivo llamado '''data.sql''' situado en la misma carpeta '''/mimodulo/sql/'''. | * En términos de orden de gestión de datos, todos deben estar en un archivo llamado '''data.sql''' situado en la misma carpeta '''/mimodulo/sql/'''. | ||
| Line 56: | Line 48: | ||
</source> | </source> | ||
Las órdenes SQL de los | Las órdenes SQL de los archivos deben de ser operacionales para la base de datos '''mysql'''. | ||
Nota: Los archivos de otras bases de datos no se mantienen. Se leen y se convierten al vuelo por el driver de la base de datos. | Nota: Los archivos de otras bases de datos no se mantienen. Se leen y se convierten al vuelo por el driver de la base de datos. | ||
== Probar | == Probar su archivo .sql == | ||
Una vez que los | Una vez que los archivos estén listos, puede volver a Dolibarr para desactivar el módulo, eliminar las tablas de la base de datos y reactivar el módulo. Las tablas deben ser recreadas por la activación del módulo. Si no es así, verifique sus scripts o consulte los logs Dolibarr. | ||
== Generar la clase PHP de acceso == | == Generar la clase PHP de acceso == | ||
Una vez que | Una vez que su/s tabla/s estén creadas en la base de datos, vaya al directorio '''dev/skeletons''' y ejecute el script | ||
<source lang="bash"> | <source lang="bash"> | ||
php build_class_from_table.php nombretabla | php build_class_from_table.php nombretabla | ||
</source> | </source> | ||
Nota: Si el comando no funciona, | Nota: Si el comando no funciona, intente con php-cli en lugar de php. | ||
Esto genera un | Esto genera un archivo '''out.nombretabla.class.php''' que contiene la clase de gestión de la tabla “nombretabla”. En esta clase se encuentran los métodos CRUD (Create/Read/Update/Delete) ya operativos para hacer un ''insert'', un ''fetch'' (''select''), un ''update'', y un ''delete'' de una línea de la tabla. Suprima justo el "out" del nombre del archivo y pógalo en un subdirectorio de '''htdocs''' propio en su módulo (Por ejemplo en '''htdocs/mimodulo'''). | ||
Un | Un archivo '''out.nombretabla_script.php''' se genera igualmente y contiene un ejemplo de código para utilizar la clase para cada uno de los cuatro métodos CRUD. | ||
= [[File:Art.png]] Crear tus páginas pantalla PHP (opcional)= | = [[File:Art.png]] Crear tus páginas pantalla PHP (opcional)= | ||