Documents générés: Difference between revisions

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
No edit summary
m (Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Generated_documents" update.)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<!-- BEGIN interlang links -->
<!-- Do NOT edit this section
    Links below are automatically managed by PolyglotBot
    You can edit links on the English source page : Generated_documents -->
[[en:Generated_documents]]
[[es:Documentos_generados]]
[[zh:生成的文件]]
<!-- END interlang links -->
{{TemplateDocDev}}
{{TemplateDocDev}}
Pour savoir comment générer un modèle de document PDF, voir la page [[Créer un modèle de document PDF]].
Créer un modèle de document PDF requiert des connaissance en développement PHP mais pas la création d'un modèle de document ODT.
Les documents générés sont stockés dans le répertoire définit par la constantes DOL_DATA_ROOT
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 =
= 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
Si vous générez des documents dans un nouveau module, vos fichiers générés doivent être dans
* DOL_DATA_ROOT/monmodule  pour des fichiers permanents.
* DOL_DATA_ROOT/monmodule  pour des fichiers permanents.
* DOL_DATA_ROOT/monmodule/temp  pour des fichiers temporaires.
* DOL_DATA_ROOT/monmodule/temp  pour des fichiers temporaires.
Pour créer ces répertoires, vous pouvez utiliser la fonction
Pour créer ces répertoires, vous pouvez utiliser la fonction
create_exdir(DOL_DATA_ROOT/monmodule);
<syntaxHighlight lang="php">
dol_mkdir(DOL_DATA_ROOT.'/monmodule');
</syntaxHighlight>


Pour générer ces fichiers sur le modèle de Dolibarr, voici les fichiers à créer:
Pour générer ces fichiers sur le modèle de Dolibarr, voici les fichiers à créer:
# la fiche où placer la "cartouche" (affichage) permettant à l'utilisateur de générer un nouveau document et de consulter les documents existants
# la page où placer la "cartouche" (affichage) permettant à l'utilisateur de générer un nouveau document et de consulter les documents existants
# ''htdocs/includes/modules/mod[type de document].class.php'' au cas où ce fichier n'existerait pas déjà
# ''htdocs/core/modules/mod[type de document].class.php'' au cas où ce fichier n'existerait pas déjà
# ''htdocs/includes/modules/[type de document]/module_[type].php'' qui contiendra la définition de la classe de génération
# ''htdocs/core/modules/[type de document]/module_[type].php'' qui contiendra la définition de la classe de génération
# ''htdocs/includes/modules/[type de document]/pdf_[modele]_[type].modules.php'' qui contiendra le modèle de génération du document
# ''htdocs/core/modules/[type de document]/pdf_[modele]_[type].modules.php'' qui contiendra le modèle de génération du document
# ''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
# ''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
# 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)
# 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:
Pour pouvoir downloader les fichiers générés en utilisant le mécanisme de sécurité de Dolibarr, il convient de
# ''htdocs/html.form.class.php'' pour y ajouter, dans la méthode '''show_documents()''', le type de document ajouté
{{ToComplete}}


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:
Plus de documentation au sujet de la fabrication des modèles eux-mêmes, est disponible sur la page [[Créer un modèle de document PDF]] ou [[Créer un modèle de document ODT]].
[[Créer un modèle de document]]

Latest revision as of 07:34, 9 October 2023


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 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

dol_mkdir(DOL_DATA_ROOT.'/monmodule');

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

  1. la page où placer la "cartouche" (affichage) permettant à l'utilisateur de générer un nouveau document et de consulter les documents existants
  2. htdocs/core/modules/mod[type de document].class.php au cas où ce fichier n'existerait pas déjà
  3. htdocs/core/modules/[type de document]/module_[type].php qui contiendra la définition de la classe de génération
  4. htdocs/core/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

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 ページは未完成の状態です。完成させるにはアカウントを作成し、ページに戻って「編集」をクリックして下さい。


Plus de documentation au sujet de la fabrication des modèles eux-mêmes, est disponible sur la page Créer un modèle de document PDF ou Créer un modèle de document ODT.