dolibarr  7.0.0-beta
Public Member Functions | List of all members
doc_generic_odt Class Reference

Class to build documents using ODF templates generator. More...

+ Inheritance diagram for doc_generic_odt:
+ Collaboration diagram for doc_generic_odt:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 info ($langs)
 Return description of a module. More...
 
 write_file ($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk using the generic odt module. More...
 
- Public Member Functions inherited from CommonDocGenerator
 __construct ($db)
 Constructor. More...
 
 get_substitutionarray_user ($user, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_mysoc ($mysoc, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_thirdparty ($object, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_contact ($object, $outputlangs, $array_key= 'object')
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_other ($outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_object ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_lines ($line, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_shipment_lines ($line, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=true)
 Define array with couple subtitution key => subtitution value. More...
 
 fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
 Fill array with couple extrafield key => extrafield value. More...
 
 printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
 Rect pdf. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ModeleThirdPartyDoc
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules. More...
 

Detailed Description

Class to build documents using ODF templates generator.

Definition at line 35 of file doc_generic_odt.modules.php.

Constructor & Destructor Documentation

doc_generic_odt::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 47 of file doc_generic_odt.modules.php.

References description, name, and type.

Member Function Documentation

doc_generic_odt::info (   $langs)

Return description of a module.

Parameters
Translate$langsObject language
Returns
string Description

Definition at line 83 of file doc_generic_odt.modules.php.

References $form, description, dol_dir_list(), and img_warning().

doc_generic_odt::write_file (   $object,
  $outputlangs,
  $srctemplatepath,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0 
)

Function to build a document on disk using the generic odt module.

Parameters
Societe$objectObject source to build document
Translate$outputlangsLang output object
string$srctemplatepathFull path of source filename for generator using a template file
int$hidedetailsDo not show line details
int$hidedescDo not show desc
int$hiderefDo not show ref
Returns
int 1 if OK, <=0 if KO

Definition at line 178 of file doc_generic_odt.modules.php.

References complete_substitutions_array(), dol_mkdir(), dol_now(), dol_print_date(), dol_sanitizeFileName(), dol_string_nospecial(), dol_syslog(), CommonDocGenerator\get_substitutionarray_contact(), CommonDocGenerator\get_substitutionarray_mysoc(), CommonDocGenerator\get_substitutionarray_other(), CommonDocGenerator\get_substitutionarray_thirdparty(), and CommonDocGenerator\get_substitutionarray_user().


The documentation for this class was generated from the following file: