dolibarr 19.0.4
doc_generic_ticket_odt Class Reference

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

Inheritance diagram for doc_generic_ticket_odt:
Collaboration diagram for doc_generic_ticket_odt:

Public Member Functions

 __construct ($db)
 Constructor.
 
 info ($langs)
 Return description of a module.
 
 write_file ($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk using the generic odt module.
 
 get_substitutionarray_object ($object, $outputlangs, $array_key='object')
 get substitution array for object
 
- Public Member Functions inherited from CommonDocGenerator
 get_substitutionarray_user ($user, $outputlangs)
 Define array with couple substitution key => substitution value.
 
 getSubstitutionarrayMember ($member, $outputlangs)
 Define array with couple substitution key => substitution value.
 
 get_substitutionarray_mysoc ($mysoc, $outputlangs)
 Define array with couple substitution key => substitution value.
 
 get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
 Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}.
 
 get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value.
 
 get_substitutionarray_other ($outputlangs)
 Define array with couple substitution key => substitution value.
 
 get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
 Define array with couple substitution key => substitution value.
 
 fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
 Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted.
 
 printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
 Rect pdf.
 
 columnSort ($a, $b)
 uasort callback function to Sort columns fields
 
 prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Prepare Array Column Field.
 
 getColumnContentWidth ($colKey)
 get column content width from column key
 
 getColumnContentXStart ($colKey)
 get column content X (abscissa) left position from column key
 
 getColumnRank ($colKey)
 get column position rank from column key
 
 insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false)
 get column position rank from column key
 
 printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
 print standard column content
 
 printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
 print description column content
 
 getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
 get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block
 
 getColumnStatus ($colKey)
 get column status from column key
 
 pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
 Print standard column content.
 
 defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
 Define Array Column Field for extrafields.
 
 defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Define Array Column Field into $this->cols This method must be implemented by the module that generate the document with its own columns.
 

Additional Inherited Members

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

Detailed Description

Class to build documents using ODF templates generator.

Definition at line 37 of file doc_generic_ticket_odt.modules.php.

Constructor & Destructor Documentation

◆ __construct()

doc_generic_ticket_odt::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 51 of file doc_generic_ticket_odt.modules.php.

References description, name, and type.

Member Function Documentation

◆ get_substitutionarray_object()

doc_generic_ticket_odt::get_substitutionarray_object ( $object,
$outputlangs,
$array_key = 'object' )

get substitution array for object

Parameters
User$objectuser
Translate$outputlangstranslation object
string$array_keykey for array
Returns
array array of substitutions

Reimplemented from CommonDocGenerator.

Definition at line 417 of file doc_generic_ticket_odt.modules.php.

◆ info()

doc_generic_ticket_odt::info ( $langs)

Return description of a module.

Parameters
Translate$langsLang object to use for output
Returns
string Description

Definition at line 93 of file doc_generic_ticket_odt.modules.php.

References description, dol_dir_list(), getDolGlobalString(), getMaxFileSizeArray(), img_picto(), img_warning(), and name.

◆ write_file()

doc_generic_ticket_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
User$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 194 of file doc_generic_ticket_odt.modules.php.

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


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