Generated documents

From Dolibarr Wiki

Return to developer
documentation index

Image:En_verysmall.png Page waiting for translation. To translate, create an account, go back and clic on "Modify".
Image:Fr_verysmall.png Page en attente de traduction. Pour traduire, créez un compte, revenez et cliquez sur "Modifier".
Image:Es_verysmall.png Página a traducir. Para traducirla, cree una cuenta, vuelva a la página y haga clic en "editar"

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 générés seront 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_).

Plus de documentation au sujet de la génération des modèles elle-même est disponible sur la page d'aperçu des modèles: Creer un modele de document

Personal tools
In other languages
FrenchSpanish