dolibarr 20.0.0
|
Class to build documents using ODF templates generator. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
get_substitutionarray_object ($object, $outputlangs, $array_key='object') | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_tasks (Task $task, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_project_contacts ($contact, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_project_file ($file, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_project_reference ($refdetail, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_tasksressource ($taskresource, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_taskstime ($tasktime, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_task_file ($file, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
info ($langs) | |
Return description of a module. | |
write_file ($object, $outputlangs, $srctemplatepath) | |
Function to build a document on disk using the generic odt module. | |
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 ModelePDFProjects | |
static | liste_modeles ($db, $maxfilenamelength=0) |
Return list of active generation modules. | |
Class to build documents using ODF templates generator.
Definition at line 79 of file doc_generic_project_odt.modules.php.
doc_generic_project_odt::__construct | ( | $db | ) |
Constructor.
Reimplemented from CommonDocGenerator.
Definition at line 93 of file doc_generic_project_odt.modules.php.
References description, name, and type.
doc_generic_project_odt::get_substitutionarray_object | ( | $object, | |
$outputlangs, | |||
$array_key = 'object' ) |
Define array with couple substitution key => substitution value.
CommonObject | $object | Main object to use as data source |
Translate | $outputlangs | Lang object to use for output |
string | $array_key | Name of the key for return array |
Definition at line 141 of file doc_generic_project_odt.modules.php.
References $object, dol_print_date(), dol_syslog(), and CommonDocGenerator\fill_substitutionarray_with_extrafields().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_project_contacts | ( | $contact, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
Definition at line 223 of file doc_generic_project_odt.modules.php.
References dol_syslog().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_project_file | ( | $file, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
array | $file | file array |
Translate | $outputlangs | Lang object to use for output |
Definition at line 280 of file doc_generic_project_odt.modules.php.
References dol_print_date().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_project_reference | ( | $refdetail, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
array | $refdetail | Reference array |
Translate | $outputlangs | Lang object to use for output |
Definition at line 298 of file doc_generic_project_odt.modules.php.
References dol_print_date(), and price().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_task_file | ( | $file, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
array | $file | file array |
Translate | $outputlangs | Lang object to use for output |
Definition at line 373 of file doc_generic_project_odt.modules.php.
References dol_print_date().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_tasks | ( | Task | $task, |
$outputlangs ) |
Define array with couple substitution key => substitution value.
Definition at line 182 of file doc_generic_project_odt.modules.php.
References convertSecondToTime(), dol_print_date(), and CommonDocGenerator\fill_substitutionarray_with_extrafields().
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_tasksressource | ( | $taskresource, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
array | $taskresource | Reference array |
Translate | $outputlangs | Lang object to use for output |
Definition at line 322 of file doc_generic_project_odt.modules.php.
Referenced by write_file().
doc_generic_project_odt::get_substitutionarray_taskstime | ( | $tasktime, | |
$outputlangs ) |
Define array with couple substitution key => substitution value.
array | $tasktime | Array of times object |
Translate | $outputlangs | Lang object to use for output |
Definition at line 346 of file doc_generic_project_odt.modules.php.
References convertSecondToTime(), and dol_print_date().
Referenced by write_file().
doc_generic_project_odt::info | ( | $langs | ) |
Return description of a module.
Translate | $langs | Lang object to use for output |
Definition at line 390 of file doc_generic_project_odt.modules.php.
References description, dol_dir_list(), getDolGlobalString(), getMaxFileSizeArray(), img_picto(), img_warning(), name, and newToken().
doc_generic_project_odt::write_file | ( | $object, | |
$outputlangs, | |||
$srctemplatepath ) |
Function to build a document on disk using the generic odt module.
Project | $object | Object source to build document |
Translate | $outputlangs | Lang output object |
string | $srctemplatepath | Full path of source filename for generator using a template file |
Definition at line 493 of file doc_generic_project_odt.modules.php.
References $object, complete_substitutions_array(), dol_dir_list(), dol_mkdir(), dol_now(), dol_print_date(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), get_default_tva(), CommonDocGenerator\get_substitutionarray_contact(), CommonDocGenerator\get_substitutionarray_each_var_object(), CommonDocGenerator\get_substitutionarray_mysoc(), get_substitutionarray_object(), CommonDocGenerator\get_substitutionarray_other(), get_substitutionarray_project_contacts(), get_substitutionarray_project_file(), get_substitutionarray_project_reference(), get_substitutionarray_task_file(), get_substitutionarray_tasks(), get_substitutionarray_tasksressource(), get_substitutionarray_taskstime(), CommonDocGenerator\get_substitutionarray_thirdparty(), CommonDocGenerator\get_substitutionarray_user(), getCommonSubstitutionArray(), getDolGlobalString(), and price2num().