Generated documents: Difference between revisions
No edit summary |
|||
| 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 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: | ||
{{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. | ||
Revision as of 00:54, 2 November 2012
The generated documents are stored in the directory defined by the constant DOL_DATA_ROOT
To generate documents in new modules
If you generate documents in a new module, your files must be stored in
- DOL_DATA_ROOT/monmodule for permanent files.
- DOL_DATA_ROOT/monmodule/temp for temporary files.
To create these directories, you can use the function
dol_mkdir(DOL_DATA_ROOT.'/monmodule');
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.
- htdocs/includes/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/includes/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
- 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)
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:
|
|
Page waiting to complete. To complete, create an account, go back and clic on "Modify".
Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
Seite wartet auf Vervollständigung. Um zu helfen, erstelle ein Konto, gehe zurück und klicke auf "Bearbeiten".
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.