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

Inheritance diagram for CommonDocGenerator:

[legend]

Public Member Functions
	__construct ($db)
	Constructor. More...

	get_substitutionarray_user ($user, $outputlangs)
	Define array with couple substitution key => substitution value. More...

	getSubstitutionarrayMember ($member, $outputlangs)
	Define array with couple substitution key => substitution value. More...

	get_substitutionarray_mysoc ($mysoc, $outputlangs)
	Define array with couple substitution key => substitution value. More...

	get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
	Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}. More...

	get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value. More...

	get_substitutionarray_other ($outputlangs)
	Define array with couple substitution key => substitution value. More...

	get_substitutionarray_object ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...

	get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...

	get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...

	get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
	Define array with couple substitution key => substitution value. More...

	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. More...

	printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
	Rect pdf. More...

	columnSort ($a, $b)
	uasort callback function to Sort columns 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='', $insertAfterTarget=false)
	get column position rank from column key More...

	printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
	print standard column content More...

	printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
	print description column content More...

	getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
	get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block More...

	getColumnStatus ($colKey)
	get column status from column key More...

	pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
	Print standard column content. More...

	defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
	Define Array Column Field for extrafields. More...

	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. More...

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

CommonDocGenerator::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

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

Definition at line 177 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 1065 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 1672 of file commondocgenerator.class.php.

◆ 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_standard_recruitmentjobposition, pdf_standard_myobject, pdf_zenith, pdf_cornas, pdf_eagle_proforma, pdf_cyan, pdf_vinci, pdf_sponge, pdf_espadon, pdf_storm, pdf_eratosthene, and pdf_standard_asset.

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

◆ 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 951 of file commondocgenerator.class.php.

◆ 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 409 of file commondocgenerator.class.php.

◆ 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 902 of file commondocgenerator.class.php.

◆ 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

Object	$line	Object line
Translate	$outputlangs	Lang 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 709 of file commondocgenerator.class.php.

◆ 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 284 of file commondocgenerator.class.php.

◆ get_substitutionarray_object()

CommonDocGenerator::get_substitutionarray_object	(	$object,
		$outputlangs,
		$array_key = `'object'`
	)

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

Parameters

Object	$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

Reimplemented in doc_generic_user_odt, doc_generic_ticket_odt, doc_generic_task_odt, doc_generic_project_odt, and doc_generic_member_odt.

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

◆ 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 467 of file commondocgenerator.class.php.

◆ 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 836 of file commondocgenerator.class.php.

◆ 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 343 of file commondocgenerator.class.php.

◆ 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 191 of file commondocgenerator.class.php.

◆ 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 1159 of file commondocgenerator.class.php.

◆ 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 1172 of file commondocgenerator.class.php.

◆ 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 1184 of file commondocgenerator.class.php.

◆ 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 1572 of file commondocgenerator.class.php.

◆ getExtrafieldContent()

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

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

Parameters

object	$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 1331 of file commondocgenerator.class.php.

◆ 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 237 of file commondocgenerator.class.php.

◆ 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 1201 of file commondocgenerator.class.php.

◆ pdfTabTitles()

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

Print standard column content.

Parameters

TCPDI	$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 1591 of file commondocgenerator.class.php.

◆ 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 1089 of file commondocgenerator.class.php.

◆ printColDescContent()

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

print description column content

Parameters

TCPDF	$pdf	pdf object
float	$curY	curent 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 1294 of file commondocgenerator.class.php.

◆ printRect()

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

Rect pdf.

Parameters

TCPDF	$pdf	Object PDF
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 1045 of file commondocgenerator.class.php.

◆ printStdColumnContent()

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

print standard column content

Parameters

TCPDF	$pdf	pdf object
float	$curY	curent Y position
string	$colKey	the column key
string	$columnText	column text

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

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

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

dolibarr_19.0/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_object()

◆ get_substitutionarray_other()

◆ get_substitutionarray_shipment()

◆ get_substitutionarray_thirdparty()

◆ get_substitutionarray_user()

◆ getColumnContentWidth()

◆ getColumnContentXStart()

◆ getColumnRank()

◆ getColumnStatus()

◆ getExtrafieldContent()

◆ getSubstitutionarrayMember()

◆ insertNewColumnDef()

◆ pdfTabTitles()

◆ prepareArrayColumnField()

◆ printColDescContent()

◆ printRect()

◆ printStdColumnContent()