dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
doc_generic_project_odt Class Reference

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

+ Inheritance diagram for doc_generic_project_odt:
+ Collaboration diagram for doc_generic_project_odt:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 get_substitutionarray_object ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_tasks ($task, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_project_contacts ($contact, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_project_file ($file, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_project_reference ($refdetail, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_tasksressource ($taskressource, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_taskstime ($tasktime, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_task_file ($file, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 info ($langs)
 Return description of a module. More...
 
 write_file ($object, $outputlangs, $srctemplatepath)
 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...
 
 columnSort ($a, $b)
 uasort callback function to Sort colums fields More...
 
 prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Prepare Array Column Field. More...
 
 getColumnContentWidth ($colKey)
 get column content width from column key More...
 
 getColumnContentXStart ($colKey)
 get column content X (abscissa) left position from column key More...
 
 getColumnRank ($colKey)
 get column position rank from column key More...
 
 insertNewColumnDef ($newColKey, $defArray, $targetCol=false, $insertAfterTarget=false)
 get column position rank from column key More...
 
 printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
 print standard column content More...
 
 getColumnStatus ($colKey)
 get column status from column key More...
 

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

Additional Inherited Members

- Static Public Member Functions inherited from ModelePDFProjects
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 55 of file doc_generic_project_odt.modules.php.

Constructor & Destructor Documentation

◆ __construct()

doc_generic_project_odt::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 81 of file doc_generic_project_odt.modules.php.

Member Function Documentation

◆ get_substitutionarray_object()

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

Define array with couple substitution key => substitution value.

Parameters
Project$objectMain object to use as data source
Translate$outputlangsLang object to use for output
string$array_keyName of the key for return array
Returns
array Array of substitution

Definition at line 129 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_project_contacts()

doc_generic_project_odt::get_substitutionarray_project_contacts (   $contact,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$contactContact array
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 208 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_project_file()

doc_generic_project_odt::get_substitutionarray_project_file (   $file,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$filefile array
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 266 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_project_reference()

doc_generic_project_odt::get_substitutionarray_project_reference (   $refdetail,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$refdetailReference array
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 286 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_task_file()

doc_generic_project_odt::get_substitutionarray_task_file (   $file,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$filefile array
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 363 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_tasks()

doc_generic_project_odt::get_substitutionarray_tasks (   $task,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$taskTask Object
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 167 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_tasksressource()

doc_generic_project_odt::get_substitutionarray_tasksressource (   $taskressource,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
array$taskressourceReference array
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 310 of file doc_generic_project_odt.modules.php.

◆ get_substitutionarray_taskstime()

doc_generic_project_odt::get_substitutionarray_taskstime (   $tasktime,
  $outputlangs 
)

Define array with couple substitution key => substitution value.

Parameters
object$tasktimetimes object
Translate$outputlangsLang object to use for output
Returns
array Return a substitution array

Definition at line 334 of file doc_generic_project_odt.modules.php.

◆ info()

doc_generic_project_odt::info (   $langs)

Return description of a module.

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

Definition at line 382 of file doc_generic_project_odt.modules.php.

◆ write_file()

doc_generic_project_odt::write_file (   $object,
  $outputlangs,
  $srctemplatepath 
)

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

Parameters
Project$objectObject source to build document
Translate$outputlangsLang output object
string$srctemplatepathFull path of source filename for generator using a template file
Returns
int 1 if OK, <=0 if KO

Definition at line 474 of file doc_generic_project_odt.modules.php.


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