Desarrollo Canvas

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search



Los Canvas son una funcionalidad del desarrollador para reemplazar formularios para crear, actualizar o mostrar objetos (productos, terceros, contactos, etc.).

Por ejemplo, puede reemplazar el formulario de entrada para la creación de un nuevo tercero o el formulario de edición o visualización para verlo.

Condiciones

Las funciones de Canvas están disponibles con la versión 3.2 o superior.

Actualmente está disponible para los siguientes elementos:

  • formulario de creación de producto, contacto y terceros
  • formulario para editar productos, contactos y terceros
  • visualización de pestaña para productos, contactos y terceros. En la mayoría de los casos, es solo la primera pestaña al ver el objeto que es compatible. Pero también puedes echar un vistazo a la página Desarrollo de módulos para saber cómo deshabilitar o agregar pestañas si realmente desea intervenir también en otras pestañas.

Reemplace el formulario de creación con su página de Canvas

Lo primero que debe hacer es encontrar la URL del formulario de creación estándar para anular y agregar el parámetro canvas = mycanvas @ mymodule. Para encontrar la URL, puede ir a la página y obtener la URL que se encuentra en la parte superior de su navegador.

Por ejemplo, digamos que desea reemplazar el formulario de creación de terceros por el suyo. La URL es algo como

http: //mydomain/societe/soc.php? action = create & leftmenu = clients

Después de agregar el parámetro de Canvas, la URL se verá así

http: //mydomain/societe/soc.php? action = create & leftmenu = clients & canvas = mycanvas @ mymodule

Cuando agrega un parámetro canvas = mycanvas @ mymodule en una página de creación, Dolibarr usará el archivo de plantilla en htdocs llamado

/ mymodule / canvas / mycanvas / tpl / nom de tabulation _create.tpl.php

o

  • El directorio mymodule es el valor mymodule que se encuentra en el parámetro canvas (usted elige este valor y crea un directorio con el mismo valor. Use valores en minúsculas).
  • mycanvas es el valor mycanvas que se encuentra en el parámetro canvas (usted elige este valor y crea un directorio con el mismo valor. Use un valor en minúsculas).
  • nom_table es el nombre de la pestaña o página donde se almacenó el formulario inicial. En la mayoría de los casos, se trata de un valor de "tarjeta".

Por ejemplo, usaremos el valor " company @ societe " para el parámetro canvas. Este es un valor de una plantilla de demostración ya codificada para terceros, que no se utiliza en el uso estándar de Dolibarr, pero se proporciona como "démo". Entonces, la URL para crear un tercero usando este patrón alternativo es ahora:

http: //mydomain/societe/soc.php? action = create & leftmenu = clients & canvas = societe @ company

Esto significa que el formulario para crear el tercero se encontrará en el archivo de plantilla:

/societe/canvas/company/tpl/card_create.tpl.php

Entonces, para usar su propio modelo, simplemente elija un valor para mymodule, mycanvas, copie y pegue un modelo de demostración que se encuentra en los directorios Dolibarr con un nuevo directorio y nombre de archivo, luego edite el modelo como desee. La plantilla contiene toda la parte debajo del menú superior y a la derecha del menú de la izquierda. Puede cambiar la apariencia, el orden de los campos, agregar sus controles javascript, eliminar o agregar sus propios campos. El único requisito es mantener los campos obligatorios del mismo nombre para evitar errores al enviar la página. Los campos eliminados se completarán con nulo o 0 en la base de datos. Los nuevos campos por el momento se ignoran. Más adelante veremos cómo agregar código para guardarlos.

Hecho esto, ahora debe agregar la nueva URL de creación en los menús de Dolibarr o reemplazar la existente por una nueva. Para hacer esto, vea la página Menus_system .

Tenga en cuenta que cuando se guarda un registro usando un patrón, el nombre del patrón mycanvas @ mymodule también se almacena en la base de datos. Esto es importante porque significa que Dolibarr podrá saber que esta grabación es un lienzo y no otro. Por lo tanto, podrá sugerir una vista o modificar un formulario dedicado únicamente a este registro y continuará utilizando formularios estándar para otros registros. Consulte los capítulos siguientes.

Reemplazar un formulario de edición con su propia plantilla

Usar su propio formulario de edición para un registro guardado usando su propio formulario de creación es tan fácil como agregar un archivo llamado

/mymodule/canvas/mycanvas/tpl/tabname_edit.tpl.php

o

  • El directorio mymodule es el valor mymodule que usó como parámetro del área de trabajo para crear un registro (consulte el capítulo anterior).
  • mycanvas es el valor de mycanvas que usó como parámetro de canvas para crear un registro (consulte el capítulo anterior).
  • nom_table es el nombre de la pestaña o página para modificar el registro. En la mayoría de los casos, se trata de un valor de "tarjeta".

Con nuestra demostración de lienzo societe @ company, el modelo de ensamblaje estará en el archivo

/societe/canvas/company/tpl/card_edit.tpl.php

Tenga en cuenta que para modificar, no es necesario modificar la URL. Dolibarr puede detectar que su grabación es una grabación de lienzo personalizada y digitalizar automáticamente este archivo de plantilla para mostrarlo si lo encuentra. De lo contrario, se utilizará el formulario estándar. Entonces, todo lo que necesita hacer para usar su propia plantilla de edición es copiar y pegar un archivo de plantilla de edición existente y cambiarle el nombre con el valor correcto de mymodule y mycanvas y editarlo según sus necesidades. En cuanto a la creación, se deben mantener todos los campos obligatorios para evitar errores al enviar el formulario para guardar cambios.

Reemplazar un formulario de vista con su propia plantilla

Usar su propio formulario de vista para un registro guardado usando su propio formulario de creación es tan fácil como agregar un archivo llamado

/mymodule/canvas/mycanvas/tpl/tabname_view.tpl.php

o

  • El directorio mymodule es el valor mymodule que usó como parámetro del área de trabajo para crear un registro (consulte el capítulo anterior).
  • mycanvas es el valor de mycanvas que usó como parámetro de canvas para crear un registro (consulte el capítulo anterior).
  • nom_table es el nombre de la pestaña o página para modificar el registro. En la mayoría de los casos, se trata de un valor de "tarjeta".

Con nuestra demostración de lienzo societe @ company, el modelo de vista estará en el archivo

/societe/canvas/company/tpl/card_view.tpl.php

Tenga en cuenta que para la visualización no es necesario cambiar la URL. Dolibarr puede detectar que su grabación es una grabación de lienzo personalizada y digitalizar automáticamente este archivo de plantilla para mostrarlo si lo encuentra. De lo contrario, se utilizará el formulario estándar. Entonces, todo lo que necesita hacer para usar su propio modelo de vista es copiar y pegar un archivo de modelo de vista de demostración existente y cambiarle el nombre con el valor correcto de mymodule y mycanvas y modificarlo según sus necesidades.

En verysmall.png Page waiting to complete. To complete, create an account, go back and clic on "Modify".
Fr verysmall.png Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
Es verysmall.png Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
De verysmall.png Seite wartet auf Vervollständigung. Um zu helfen, erstelle ein Konto, gehe zurück und klicke auf "Bearbeiten".
Cn verysmall.png 待完成,欲帮助完成,注册帐号,点击“编辑"
Jp verysmall.png ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。