Parent class for documents (PDF, ODT, ...) generators. More...

Inheritance diagram for CommonDocGenerator:

[legend]

Public Member Functions
	__construct ($db)
	Constructor.

	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.

Detailed Description

Parent class for documents (PDF, ODT, ...) generators.

Definition at line 38 of file commondocgenerator.class.php.

Constructor & Destructor Documentation

◆ __construct()

CommonDocGenerator::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented in BordereauChequeBlochet, CommonStickerGenerator, doc_generic_asset_odt, doc_generic_bom_odt, doc_generic_contract_odt, doc_generic_invoice_odt, doc_generic_member_odt, doc_generic_mo_odt, doc_generic_myobject_odt, doc_generic_odt, doc_generic_order_odt, doc_generic_product_odt, doc_generic_project_odt, doc_generic_proposal_odt, doc_generic_reception_odt, doc_generic_recruitmentjobposition_odt, doc_generic_shipment_odt, doc_generic_stock_odt, doc_generic_supplier_invoice_odt, doc_generic_supplier_order_odt, doc_generic_supplier_proposal_odt, doc_generic_task_odt, doc_generic_ticket_odt, doc_generic_user_odt, doc_generic_usergroup_odt, ExportCsvIso, ExportCsvUtf8, ExportExcel2007, ExportTsv, html_cerfafr, html_generic, pdf_aurore, pdf_azur, pdf_baleine, pdf_ban, pdf_beluga, pdf_canelle, pdf_cornas, pdf_crabe, pdf_cyan, pdf_eagle_proforma, pdf_muscadet, pdf_octopus, pdf_paiement, pdf_paiement_fourn, pdf_proforma, pdf_sepamandate, pdf_soleil, pdf_sponge, pdf_standard, pdf_standard_asset, pdf_standard_evaluation, pdf_standard_expensereport, pdf_standard_member, pdf_standard_movementstock, pdf_standard_myobject, pdf_standard_recruitmentjobposition, pdf_standard_stock, pdf_standard_supplierpayment, pdf_storm, pdf_strato, pdf_timespent, pdf_typhon, pdf_vinci, and pdf_zenith.

Definition at line 190 of file commondocgenerator.class.php.

Member Function Documentation

◆ columnSort()

CommonDocGenerator::columnSort	(		$a,
			$b )

uasort callback function to Sort columns fields

Parameters

array	$a	PDF lines array fields configs
array	$b	PDF lines array fields configs

Returns: int Return compare result

Definition at line 1085 of file commondocgenerator.class.php.

◆ defineColumnExtrafield()

CommonDocGenerator::defineColumnExtrafield	(	$object,
		$outputlangs,
		$hidedetails = 0 )

Define Array Column Field for extrafields.

Parameters

object	$object	common object det
Translate	$outputlangs	langs
int	$hidedetails	Do not show line details

Returns: int Return integer <0 if KO, >=0 if OK

Definition at line 1705 of file commondocgenerator.class.php.

References $object, and insertNewColumnDef().

Referenced by pdf_cornas\defineColumnField(), pdf_cyan\defineColumnField(), pdf_eagle_proforma\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_espadon\defineColumnField(), pdf_sponge\defineColumnField(), pdf_standard_asset\defineColumnField(), pdf_standard_myobject\defineColumnField(), pdf_storm\defineColumnField(), pdf_vinci\defineColumnField(), and pdf_zenith\defineColumnField().

◆ defineColumnField()

CommonDocGenerator::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.

Parameters

Object	$object	Common object
Translate	$outputlangs	Langs
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: void

Reimplemented in pdf_cornas, pdf_cyan, pdf_eagle_proforma, pdf_eratosthene, pdf_espadon, pdf_octopus, pdf_sponge, pdf_standard_asset, pdf_standard_myobject, pdf_standard_recruitmentjobposition, pdf_storm, pdf_vinci, and pdf_zenith.

Definition at line 1797 of file commondocgenerator.class.php.

Referenced by prepareArrayColumnField().

◆ fill_substitutionarray_with_extrafields()

CommonDocGenerator::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.

Parameters

Object	$object	Object with extrafields (must have $object->array_options filled)
array	$array_to_fill	Substitution array
Extrafields	$extrafields	Extrafields object
string	$array_key	Prefix for name of the keys into returned array
Translate	$outputlangs	Lang object to use for output

Returns: array Substitution array

Definition at line 971 of file commondocgenerator.class.php.

References $object, dol_include_once(), dol_print_date(), price(), and price2num().

Referenced by get_substitutionarray_contact(), get_substitutionarray_lines(), doc_generic_project_odt\get_substitutionarray_object(), doc_generic_task_odt\get_substitutionarray_object(), get_substitutionarray_shipment(), doc_generic_project_odt\get_substitutionarray_tasks(), doc_generic_task_odt\get_substitutionarray_tasks(), get_substitutionarray_thirdparty(), get_substitutionarray_user(), and getSubstitutionarrayMember().

◆ get_substitutionarray_contact()

CommonDocGenerator::get_substitutionarray_contact	(	$object,
		$outputlangs,
		$array_key = 'object' )

Define array with couple substitution key => substitution value.

Parameters

Contact	$object	contact
Translate	$outputlangs	object for output
string	$array_key	Name of the key for return array

Returns: array Array of substitution key->code

Definition at line 425 of file commondocgenerator.class.php.

References $object, fill_substitutionarray_with_extrafields(), and getState().

◆ get_substitutionarray_each_var_object()

CommonDocGenerator::get_substitutionarray_each_var_object	(	&	$object,
			$outputlangs,
			$recursive = 1 )

Define array with couple substitution key => substitution value.

Parameters

Object	$object	Dolibarr Object
Translate	$outputlangs	Language object for output
boolean \| int	$recursive	Want to fetch child array or child object.

Returns: array Array of substitution key->code

Definition at line 924 of file commondocgenerator.class.php.

References $object, and get_substitutionarray_each_var_object().

◆ get_substitutionarray_lines()

CommonDocGenerator::get_substitutionarray_lines	(	$line,
		$outputlangs,
		$linenumber = 0 )

Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.

Parameters

CommonObjectLine	$line	Object line
Translate	$outputlangs	Translate object to use for output
int	$linenumber	The number of the line for the substitution of "object_line_pos"

Returns: array Return a substitution array

Definition at line 729 of file commondocgenerator.class.php.

References doc_getlinedesc(), dol_print_date(), fill_substitutionarray_with_extrafields(), getDolGlobalInt(), price(), price2num(), and vatrate().

◆ get_substitutionarray_mysoc()

CommonDocGenerator::get_substitutionarray_mysoc	(		$mysoc,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

Societe	$mysoc	Object thirdparty
Translate	$outputlangs	Language object for output

Returns: array Array of substitution key->code

Definition at line 300 of file commondocgenerator.class.php.

References getFormeJuridiqueLabel(), and getState().

◆ get_substitutionarray_other()

CommonDocGenerator::get_substitutionarray_other ( $outputlangs )

Define array with couple substitution key => substitution value.

Parameters

Translate $outputlangs Language object for output

Returns: array Array of substitution key->code

Definition at line 483 of file commondocgenerator.class.php.

References dol_now(), dol_print_date(), and isASecretKey().

◆ get_substitutionarray_shipment()

CommonDocGenerator::get_substitutionarray_shipment	(	$object,
		$outputlangs,
		$array_key = 'object' )

Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.

Parameters

Expedition	$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 Array of substitution

Definition at line 856 of file commondocgenerator.class.php.

References $object, dol_print_date(), fill_substitutionarray_with_extrafields(), measuringUnitString(), and price().

◆ get_substitutionarray_thirdparty()

CommonDocGenerator::get_substitutionarray_thirdparty	(	$object,
		$outputlangs,
		$array_key = 'company' )

Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}.

Parameters

Societe	$object	Object
Translate	$outputlangs	Language object for output
string	$array_key	Name of the key for return array

Returns: array Array of substitution key->code

Definition at line 359 of file commondocgenerator.class.php.

References $object, fill_substitutionarray_with_extrafields(), getState(), and price().

◆ get_substitutionarray_user()

CommonDocGenerator::get_substitutionarray_user	(		$user,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

User	$user	User
Translate	$outputlangs	Language object for output

Returns: array Array of substitution key->code

Definition at line 204 of file commondocgenerator.class.php.

References dol_print_date(), fill_substitutionarray_with_extrafields(), get_exdir(), and getImageFileNameForSize().

◆ getColumnContentWidth()

CommonDocGenerator::getColumnContentWidth ( $colKey )

get column content width from column key

Parameters

string $colKey the column key

Returns: float width in mm

Definition at line 1179 of file commondocgenerator.class.php.

Referenced by pdf_storm\write_file().

◆ getColumnContentXStart()

CommonDocGenerator::getColumnContentXStart ( $colKey )

get column content X (abscissa) left position from column key

Parameters

string $colKey the column key

Returns: float X position in mm

Definition at line 1192 of file commondocgenerator.class.php.

Referenced by printStdColumnContent(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_storm\write_file(), and pdf_zenith\write_file().

◆ getColumnRank()

CommonDocGenerator::getColumnRank ( $colKey )

get column position rank from column key

Parameters

string $colKey the column key

Returns: int rank on success and -1 on error

Definition at line 1204 of file commondocgenerator.class.php.

Referenced by insertNewColumnDef().

◆ getColumnStatus()

CommonDocGenerator::getColumnStatus ( $colKey )

get column status from column key

Parameters

string $colKey the column key

Returns: boolean true if column on

Definition at line 1605 of file commondocgenerator.class.php.

Referenced by pdf_octopus\_tableau(), pdf_vinci\_tableau(), pdf_espadon\_tableau_tot(), pdfTabTitles(), prepareArrayColumnField(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_storm\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ getExtrafieldContent()

CommonDocGenerator::getExtrafieldContent	(	$object,
		$extrafieldKey,
		$outputlangs = null )

get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block

Parameters

CommonObject	$object	Common object
string	$extrafieldKey	The extrafield key
Translate	$outputlangs	The output langs (if value is __(XXX)__ we use it to translate it).

Returns: string

Definition at line 1351 of file commondocgenerator.class.php.

References $object, dol_string_nohtmltag(), and setEventMessages().

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_storm\write_file(), and pdf_zenith\write_file().

◆ getSubstitutionarrayMember()

CommonDocGenerator::getSubstitutionarrayMember	(		$member,
			$outputlangs )

Define array with couple substitution key => substitution value.

Parameters

Adherent	$member	Member
Translate	$outputlangs	Language object for output

Returns: array Array of substitution key->code

Definition at line 253 of file commondocgenerator.class.php.

References dol_print_date(), fill_substitutionarray_with_extrafields(), and get_exdir().

Referenced by doc_generic_member_odt\write_file().

◆ insertNewColumnDef()

CommonDocGenerator::insertNewColumnDef	(	$newColKey,
		$defArray,
		$targetCol = '',
		$insertAfterTarget = false )

get column position rank from column key

Parameters

string	$newColKey	the new column key
array	$defArray	a single column definition array
string	$targetCol	target column used to place the new column beside
bool	$insertAfterTarget	insert before or after target column ?

Returns: int new rank on success and -1 on error

Definition at line 1221 of file commondocgenerator.class.php.

References getColumnRank().

Referenced by defineColumnExtrafield().

◆ pdfTabTitles()

CommonDocGenerator::pdfTabTitles	(	&	$pdf,
			$tab_top,
			$tab_height,
			$outputlangs,
			$hidetop = 0 )

Print standard column content.

Parameters

TCPDI \| TCPDF	$pdf	Pdf object
float	$tab_top	Tab top position
float	$tab_height	Default tab height
Translate	$outputlangs	Output language
int	$hidetop	Hide top

Returns: float Height of col tab titles

Definition at line 1624 of file commondocgenerator.class.php.

References getColumnStatus(), and setEventMessages().

Referenced by pdf_cornas\_tableau(), pdf_cyan\_tableau(), pdf_eagle_proforma\_tableau(), pdf_eratosthene\_tableau(), pdf_espadon\_tableau(), pdf_sponge\_tableau(), pdf_standard_asset\_tableau(), pdf_standard_myobject\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), pdf_storm\_tableau(), pdf_zenith\_tableau(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), and pdf_storm\write_file().

◆ prepareArrayColumnField()

CommonDocGenerator::prepareArrayColumnField	(	$object,
		$outputlangs,
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Prepare Array Column Field.

Parameters

object	$object	common object
Translate	$outputlangs	langs
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: void

Definition at line 1109 of file commondocgenerator.class.php.

References $object, defineColumnField(), and getColumnStatus().

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_storm\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ printColDescContent()

CommonDocGenerator::printColDescContent	(		$pdf,
		&	$curY,
			$colKey,
			$object,
			$i,
			$outputlangs,
			$hideref = 0,
			$hidedesc = 0,
			$issupplierline = 0 )

print description column content

Parameters

TCPDI \| TCPDF	$pdf	Pdf object
float	$curY	current Y position
string	$colKey	the column key
object	$object	CommonObject
int	$i	the $object->lines array key
Translate	$outputlangs	Output language
int	$hideref	hide ref
int	$hidedesc	hide desc
int	$issupplierline	if object need supplier product

Returns: void

Definition at line 1314 of file commondocgenerator.class.php.

References $object, pdf_writelinedesc(), and printStdColumnContent().

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), and pdf_zenith\write_file().

◆ printRect()

CommonDocGenerator::printRect	(	$pdf,
		$x,
		$y,
		$l,
		$h,
		$hidetop = 0,
		$hidebottom = 0 )

Rect pdf.

Parameters

TCPDI \| TCPDF	$pdf	Pdf object
float	$x	Abscissa of first point
float	$y	Ordinate of first point
float	$l	??
float	$h	??
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom

Returns: void

Definition at line 1065 of file commondocgenerator.class.php.

Referenced by pdf_aurore\_tableau(), pdf_azur\_tableau(), pdf_canelle\_tableau(), pdf_cornas\_tableau(), pdf_crabe\_tableau(), pdf_cyan\_tableau(), pdf_eagle\_tableau(), pdf_eagle_proforma\_tableau(), pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_espadon\_tableau(), pdf_muscadet\_tableau(), pdf_octopus\_tableau(), pdf_rouget\_tableau(), pdf_soleil\_tableau(), pdf_sponge\_tableau(), pdf_squille\_tableau(), pdf_standard\_tableau(), pdf_standard_asset\_tableau(), pdf_standard_myobject\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), pdf_standard_stock\_tableau(), pdf_storm\_tableau(), pdf_strato\_tableau(), pdf_typhon\_tableau(), pdf_vinci\_tableau(), and pdf_zenith\_tableau().

◆ printStdColumnContent()

CommonDocGenerator::printStdColumnContent	(		$pdf,
		&	$curY,
			$colKey,
			$columnText = '' )

print standard column content

Parameters

TCPDI \| TCPDF	$pdf	Pdf object
float	$curY	current Y position
string	$colKey	the column key
string	$columnText	column text

Returns: int Return integer <0 if KO, >= if OK

Definition at line 1266 of file commondocgenerator.class.php.

References getColumnContentXStart(), and setEventMessages().

Referenced by pdf_espadon\_tableau_tot(), printColDescContent(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_storm\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

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

dolibarr_dev/htdocs/core/class/commondocgenerator.class.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ columnSort()

◆ defineColumnExtrafield()

◆ defineColumnField()

◆ fill_substitutionarray_with_extrafields()

◆ get_substitutionarray_contact()

◆ get_substitutionarray_each_var_object()

◆ get_substitutionarray_lines()

◆ get_substitutionarray_mysoc()

◆ get_substitutionarray_other()

◆ get_substitutionarray_shipment()

◆ get_substitutionarray_thirdparty()

◆ get_substitutionarray_user()

◆ getColumnContentWidth()

◆ getColumnContentXStart()

◆ getColumnRank()

◆ getColumnStatus()

◆ getExtrafieldContent()

◆ getSubstitutionarrayMember()

◆ insertNewColumnDef()

◆ pdfTabTitles()

◆ prepareArrayColumnField()

◆ printColDescContent()

◆ printRect()

◆ printStdColumnContent()