Generated documents

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

En verysmall.png Page waiting for translation. To translate, create an account, go back and clic on "Modify".
Fr verysmall.png Page en attente de traduction. Pour traduire, créez un compte, revenez et cliquez sur "Modifier".
Es verysmall.png Página a traducir. Para traducirla, cree una cuenta, vuelva a la página y haga clic en "editar".
It verysmall.png Pagina da tradurre. Per tradurla, crea un utente, torna indietro e clicca su "modifica".
Pt verysmall.png Página a aguardar por tradução. Para traduzir, crie uma conta, volte atrás e clique em "Modificar".
De verysmall.png Seite wartet auf Übersetzung. Um Übersetzung zu erstellen, richte einen Account ein, geh zurück und klicke auf "bearbeiten".
Zh verysmall.png 页面等待翻译。若要翻译本页,先创建一个帐户、登录并返回本页后单击“编辑”。

Les documents générés sont stockés dans le répertoire définit par la constantes DOL_DATA_ROOT

Générer des documents dans de nouveaux modules

Si vous générez des documents dans un nouveau module, vos fichiers doivent être dans

  • DOL_DATA_ROOT/monmodule pour des fichiers permanents.
  • DOL_DATA_ROOT/monmodule/temp pour des fichiers temporaires.

Pour créer ces répertoires, vous pouvez utiliser la fonction create_exdir(DOL_DATA_ROOT/monmodule);

Pour générer ces fichiers sur le modèle de Dolibarr, voici les fichiers à créer:

  1. la fiche où placer la "cartouche" (affichage) permettant à l'utilisateur de générer un nouveau document et de consulter les documents existants
  2. htdocs/includes/modules/mod[type de document].class.php au cas où ce fichier n'existerait pas déjà
  3. htdocs/includes/modules/[type de document]/module_[type].php qui contiendra la définition de la classe de génération
  4. htdocs/includes/modules/[type de document]/pdf_[modele]_[type].modules.php qui contiendra le modèle de génération du document
  5. htdocs/document.php qui contient la procédure de livraison des fichiers une fois créés (et leur suppression) - il faut également y ajouter le type de document et le répertoire correspondant
  6. la(les) classe(s) qui contien(nen)t les données à afficher (classes product.class.php ou facture.class.php, ou autres, selon le document à générer)

Pour pouvoir downloader les fichiers générés en utilisant le mécanisme de sécurité de Dolibarr, il convient de modifier les fichiers suivant:

  1. htdocs/html.form.class.php pour y ajouter, dans la méthode show_documents(), le type de document ajouté

Il faut également que le modèle soit inséré dans la base de données, dans la Table llx_document_model avec pour type le type de document et pour nom le nom de la classe correspondante dans includes/modules (commençant par pdf_).

To know how to build an template, see page Create an ODT document template or Create a PDF document template. Building a PDF template require PHP development knowledge, but not building an ODT template.