doc_generic_task_odt Class Reference

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

Inheritance diagram for doc_generic_task_odt:

Collaboration diagram for doc_generic_task_odt:

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, $outputlangs, $array_key='task')
	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.
	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the PDF.
	getMaxAfterColsLinePositionsData ()
	Get position in PDF after col display.
	resetAfterColsLinePositionsData (float $y, int $pageNumb)
	Used for reset afterColsLinePositions var in start of a new pdf draw line loop.
	setAfterColsLinePositionsData (string $colId, float $y, int $pageNumb)
	Used for to set afterColsLinePositions var in a pdf draw line loop.
	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 ModelePDFTask
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 78 of file doc_generic_task_odt.modules.php.

Constructor & Destructor Documentation

__construct()

doc_generic_task_odt::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Definition at line 92 of file doc_generic_task_odt.modules.php.

References description, dol_syslog(), getCallerInfoString(), name, and type.

Member Function Documentation

get_substitutionarray_object()

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

Define array with couple substitution key => substitution value.

Parameters

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

Returns

array<string,int|string> Array of substitution

Definition at line 146 of file doc_generic_task_odt.modules.php.

References $object, dol_print_date(), dol_syslog(), and CommonDocGenerator\fill_substitutionarray_with_extrafields().

Referenced by write_file().

get_substitutionarray_project_contacts()

doc_generic_task_odt::get_substitutionarray_project_contacts	(		$contact,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{id:int,rowid:int,libelle:string,lastname:string,firstname:string,fullname:string,socname:string,email:string}	$contact Contact array
Translate	$outputlangs	Lang object to use for output

Returns

array<string,int|string> Return a substitution array

Definition at line 233 of file doc_generic_task_odt.modules.php.

Referenced by write_file().

get_substitutionarray_project_file()

doc_generic_task_odt::get_substitutionarray_project_file	(		$file,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string}	$file file array
Translate	$outputlangs	Lang object to use for output

Returns

array<string,int|string> Return a substitution array

Definition at line 256 of file doc_generic_task_odt.modules.php.

References dol_print_date().

Referenced by write_file().

get_substitutionarray_project_reference()

doc_generic_task_odt::get_substitutionarray_project_reference	(		$refdetail,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{type:string,ref:string,date:int,socname:string,amountht:float|string,amountttc:float|string,status:string}	$refdetail Reference array
Translate	$outputlangs	Lang object to use for output

Returns

array<string,int|string> Return a substitution array

Definition at line 274 of file doc_generic_task_odt.modules.php.

References dol_print_date(), and price().

get_substitutionarray_task_file()

doc_generic_task_odt::get_substitutionarray_task_file	(		$file,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{name:string,date:string,size:int}	$file file array
Translate	$outputlangs	Lang object to use for output

Returns

array{tasksfile_name:string,tasksfile_date:string,tasksfile_size:int} Return a substitution array

Definition at line 345 of file doc_generic_task_odt.modules.php.

References dol_print_date().

Referenced by write_file().

get_substitutionarray_tasks()

doc_generic_task_odt::get_substitutionarray_tasks	(		$task,
			$outputlangs,
			$array_key = 'task' )

Define array with couple substitution key => substitution value.

Parameters

Task	$task	Task Object
Translate	$outputlangs	Lang object to use for output
string	$array_key	Name of the key for return array

Returns

array<string,int|string> Return a substitution array

Definition at line 190 of file doc_generic_task_odt.modules.php.

References convertSecondToTime(), dol_print_date(), and CommonDocGenerator\fill_substitutionarray_with_extrafields().

Referenced by write_file().

get_substitutionarray_tasksressource()

doc_generic_task_odt::get_substitutionarray_tasksressource	(		$taskresource,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{rowid:int,libelle:string,lastname:string,firstname:string,fullname:string,socname:string,email:string}	$taskresource Resource array
Translate	$outputlangs	Lang object to use for output

Returns

array<string,int|string> Return a substitution array

Definition at line 296 of file doc_generic_task_odt.modules.php.

Referenced by write_file().

get_substitutionarray_taskstime()

doc_generic_task_odt::get_substitutionarray_taskstime	(		$tasktime,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

	array{rowid:int,task_date:string,task_duration:int,note:string,fk_user:int,lastname:string,firstname:string,fullcivname:string}	$tasktime times object
Translate	$outputlangs	Lang object to use for output

Returns

array<string,string|int> Return a substitution array

Definition at line 320 of file doc_generic_task_odt.modules.php.

References $conf, convertSecondToTime(), and dol_print_date().

Referenced by write_file().

info()

doc_generic_task_odt::info

(

$langs

)

Return description of a module.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Description

Definition at line 362 of file doc_generic_task_odt.modules.php.

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

write_file()

doc_generic_task_odt::write_file	(		$object,
			$outputlangs,
			$srctemplatepath = '' )

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

Parameters

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

Returns

int<-1,1> 1 if OK, <=0 if KO

Reimplemented from ModelePDFTask.

Definition at line 465 of file doc_generic_task_odt.modules.php.

References $conf, $id, $object, complete_substitutions_array(), dol_dir_list(), dol_mkdir(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), 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_task_file(), get_substitutionarray_tasks(), get_substitutionarray_tasksressource(), get_substitutionarray_taskstime(), CommonDocGenerator\get_substitutionarray_thirdparty(), CommonDocGenerator\get_substitutionarray_user(), getCommonSubstitutionArray(), and getDolGlobalString().

---

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

• dolibarr_21.0/htdocs/core/modules/project/task/doc/doc_generic_task_odt.modules.php