Generated documents - Revision history

ShengGang: Add Chinese

2023-10-09T07:34:21Z

Add Chinese

← Older revision		Revision as of 07:34, 9 October 2023
Line 4:		Line 4:
	[[fr:Documents_générés]]		[[fr:Documents_générés]]
	[[es:Documentos_generados]]		[[es:Documentos_generados]]
			[[zh:生成的文件]]
	<!-- END interlang links -->		<!-- END interlang links -->

Eldy at 08:48, 17 January 2023

2023-01-17T08:48:29Z

← Older revision		Revision as of 08:48, 17 January 2023
Line 14:		Line 14:
	* DOL_DATA_ROOT/mymodule/temp for temporary files.		* DOL_DATA_ROOT/mymodule/temp for temporary files.
	To create these directories, you can use the function		To create these directories, you can use the function
	<~~source~~ lang="php">		<syntaxHighlight lang="php">
	dol_mkdir(DOL_DATA_ROOT.'/mymodule');		dol_mkdir(DOL_DATA_ROOT.'/mymodule');
	</~~source~~>		</syntaxHighlight>

	To generate these files on the Dolibarr model, create the following files:		To generate these files on the Dolibarr model, create the following files:

PolyglotBot: Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.

2019-07-23T13:20:31Z

Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.

← Older revision		Revision as of 13:20, 23 July 2019
Line 1:		Line 1:
			<!-- BEGIN origin interlang links -->
			<!-- You can edit this section but do NOT remove these comments
			Links below will be automatically replicated on translated pages by PolyglotBot -->
			[[fr:Documents_générés]]
			[[es:Documentos_generados]]
			<!-- END interlang links -->

	{{TemplateDocDevEn}}		{{TemplateDocDevEn}}
	The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT		The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT

Aikhan: /* To generate documents in new modules */

2014-05-31T09:02:22Z

To generate documents in new modules

← Older revision		Revision as of 09:02, 31 May 2014
Line 4:		Line 4:
	= To generate documents in new modules =		= To generate documents in new modules =
	If you generate documents in a new module, your files must be stored in		If you generate documents in a new module, your files must be stored in
	* DOL_DATA_ROOT/~~monmodule~~ for permanent files.		* DOL_DATA_ROOT/mymodule for permanent files.
	* DOL_DATA_ROOT/~~monmodule~~/temp for temporary files.		* DOL_DATA_ROOT/mymodule/temp for temporary files.
	To create these directories, you can use the function		To create these directories, you can use the function
	<source lang="php">		<source lang="php">

Eldy at 22:54, 7 January 2013

2013-01-07T22:54:51Z

← Older revision		Revision as of 22:54, 7 January 2013
Line 8:		Line 8:
	To create these directories, you can use the function		To create these directories, you can use the function
	<source lang="php">		<source lang="php">
	dol_mkdir(DOL_DATA_ROOT.'/~~monmodule~~');		dol_mkdir(DOL_DATA_ROOT.'/mymodule');
	</source>		</source>

	To generate these files on the Dolibarr model, create the following files:		To generate these files on the Dolibarr model, create the following files:
	# the ~~card~~ where to place the "cartouche" (posting) allowing the user to generate a new document and to consult the existing documents.		# the page where to place the "cartouche" (posting) allowing the user to generate a new document and to consult the existing documents.
	# ''htdocs/~~includes~~/modules/mod [standard of document] .class.php'' if this file wouldn't exist already		# ''htdocs/core/modules/mod [standard of document] .class.php'' if this file wouldn't exist already
	# ''htdocs/~~includes~~/modules/[standard of document] /module_ [standard] .php'' which will contain the definition of the class of generation		# ''htdocs/core/modules/[standard of document] /module_ [standard] .php'' which will contain the definition of the class of generation
	# ''htdocs/~~includes~~/modules/[standard of document] /pdf_ [model] _ [standard] .modules.php'' which will contain the model of generation of the document		# ''htdocs/core/modules/[standard of document] /pdf_ [model] _ [standard] .modules.php'' which will contain the model of generation of the document
	# ''htdocs/document.php'' which contains the procedure of delivery of the files once created (and their suppression) - it is also necessary to add to it the type of document and the corresponding directory		# ''htdocs/document.php'' which contains the procedure of delivery of the files once created (and their suppression) - it is also necessary to add to it the type of document and the corresponding directory
	# The class(es) which contain the data to be posted (classes product.class.php or facture.class.php, or others, according to the document to be generated)		# The class(es) which contain the data to be posted (classes product.class.php or facture.class.php, or others, according to the document to be generated)

Eldy: /* To generate documents in new modules */

2012-11-02T00:54:26Z

To generate documents in new modules

← Older revision		Revision as of 00:54, 2 November 2012
Line 6:		Line 6:
	* DOL_DATA_ROOT/monmodule for permanent files.		* DOL_DATA_ROOT/monmodule for permanent files.
	* DOL_DATA_ROOT/monmodule/temp for temporary files.		* DOL_DATA_ROOT/monmodule/temp for temporary files.
	To create these directories, you can use the function ~~to create_exdir~~ (DOL_DATA_ROOT/monmodule);		To create these directories, you can use the function
			<source lang="php">
			dol_mkdir(DOL_DATA_ROOT.'/monmodule');
			</source>

	To generate these files on the Dolibarr model, create the following files:		To generate these files on the Dolibarr model, create the following files:
Line 17:		Line 20:

	To be able to download the files generated by using the mechanism of safety of Dolibarr, it is advisable to modify the files according to:		To be able to download the files generated by using the mechanism of safety of Dolibarr, it is advisable to modify the files according to:
	~~# ''htdocs/html.form.class.php'' to add to it, in the method '''show_documents()''', the type of added document.~~		{{ToComplete}}

	The model also needs to be inserted into the database, in the [[Table llx_document_model]] the type of document in the type field and the name of the corresponding class in includes/modules (starting with pdf_) in the name field.		The model also needs to be inserted into the database, in the [[Table llx_document_model]] the type of document in the type field and the name of the corresponding class in includes/modules (starting with pdf_) in the name field.

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

Eldy at 01:15, 3 November 2011

2011-11-03T01:15:35Z

← Older revision		Revision as of 01:15, 3 November 2011
Line 21:		Line 21:
	The model also needs to be inserted into the database, in the [[Table llx_document_model]] the type of document in the type field and the name of the corresponding class in includes/modules (starting with pdf_) in the name field.		The model also needs to be inserted into the database, in the [[Table llx_document_model]] the type of document in the type field and the name of the corresponding class in includes/modules (starting with pdf_) in the name field.

	To know how to build a template, see page [[Create an ODT document template]] or [[Create a ~~pdf~~ document template]]. Building a pdf template requires PHP development knowledge, but building an ODT template does not.		To know how to build a template, see page [[Create an ODT document template]] or [[Create a PDF document template]]. Building a pdf template requires PHP development knowledge, but building an ODT template does not.

Eldy at 01:15, 3 November 2011

2011-11-03T01:15:05Z

← Older revision		Revision as of 01:15, 3 November 2011
Line 1:		Line 1:
	{{TemplateDocDevEn}}		{{TemplateDocDevEn}}
	~~{{ToTranslate}}~~
	The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT		The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT

Eelo: Roughly translated French to English using online translation tool and English fluency.

2011-11-03T00:32:27Z

Roughly translated French to English using online translation tool and English fluency.

← Older revision		Revision as of 00:32, 3 November 2011
Line 1:		Line 1:
	{{TemplateDocDevEn}}		{{TemplateDocDevEn}}
	{{ToTranslate}}		{{ToTranslate}}
	~~Les~~ documents ~~générés sont stockés dans le répertoire définit par la constantes~~ DOL_DATA_ROOT		The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT

	= ~~Générer des~~ documents ~~dans de nouveaux~~ modules =		= To generate documents in new modules =
	~~Si vous générez des~~ documents ~~dans un nouveau~~ module, ~~vos fichiers doivent être dans~~		If you generate documents in a new module, your files must be stored in
	* DOL_DATA_ROOT/monmodule ~~pour des fichiers permanents~~.		* DOL_DATA_ROOT/monmodule for permanent files.
	* DOL_DATA_ROOT/monmodule/temp ~~pour des fichiers temporaires~~.		* DOL_DATA_ROOT/monmodule/temp for temporary files.
	~~Pour créer ces répertoires~~, ~~vous pouvez utiliser la fonction~~		To create these directories, you can use the function to create_exdir (DOL_DATA_ROOT/monmodule);
	create_exdir(DOL_DATA_ROOT/monmodule);

	~~Pour générer ces fichiers sur le modèle de~~ Dolibarr, ~~voici les fichiers à créer~~:		To generate these files on the Dolibarr model, create the following files:
	# ~~la fiche où placer la~~ "cartouche" (~~affichage~~) ~~permettant à l'utilisateur de générer un nouveau~~ document ~~et de consulter les~~ documents ~~existants~~		# the card where to place the "cartouche" (posting) allowing the user to generate a new document and to consult the existing documents.
	# ''htdocs/includes/modules/mod[~~type de~~ document].class.php'' ~~au cas où ce fichier n~~'~~existerait pas déjà~~		# ''htdocs/includes/modules/mod [standard of document] .class.php'' if this file wouldn't exist already
	# ''htdocs/includes/modules/[~~type de~~ document]/module_[~~type~~].php'' ~~qui contiendra la définition de la classe de génération~~		# ''htdocs/includes/modules/[standard of document] /module_ [standard] .php'' which will contain the definition of the class of generation
	# ''htdocs/includes/modules/[~~type de~~ document]/pdf_[~~modele~~]_[~~type~~].modules.php'' ~~qui contiendra le modèle de génération du~~ document		# ''htdocs/includes/modules/[standard of document] /pdf_ [model] _ [standard] .modules.php'' which will contain the model of generation of the 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'' which contains the procedure of delivery of the files once created (and their suppression) - it is also necessary to add to it the type of document and the corresponding directory
	# ~~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~~)		# The class(es) which contain the data to be posted (classes product.class.php or facture.class.php, or others, according to the document to be generated)

	~~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~~:		To be able to download the files generated by using the mechanism of safety of Dolibarr, it is advisable to modify the files according to:
	# ''htdocs/html.form.class.php'' ~~pour y ajouter~~, ~~dans la méthode~~ '''show_documents()''', le type de document ~~ajouté~~		# ''htdocs/html.form.class.php'' to add to it, in the method '''show_documents()''', the type of added document.

	~~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_).		The model also needs to be inserted into the database, in the [[Table llx_document_model]] the type of document in the type field and the name of the corresponding class in includes/modules (starting with pdf_) in the name field.

	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.		To know how to build a template, see page [[Create an ODT document template]] or [[Create a pdf document template]]. Building a pdf template requires PHP development knowledge, but building an ODT template does not.

Eldy: /* Générer des documents dans de nouveaux modules */

2011-10-14T10:50:15Z

Générer des documents dans de nouveaux modules

← Older revision		Revision as of 10:50, 14 October 2011
Line 4:		Line 4:

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