ModelePDFFactures Class Reference

Parent class of invoice document generators. More...

Inheritance diagram for ModelePDFFactures:

Collaboration diagram for ModelePDFFactures:

Public Member Functions
	addBottomQRInvoice (TCPDF $pdf, Facture $object, Translate $langs)
	Add SwissQR invoice at bottom of page 1.
Public Member Functions inherited from CommonDocGenerator
	__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.

Static Public Member Functions
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation modules.

Protected Member Functions
	getHeightForQRInvoice (int $pagenbr, Facture $object, Translate $langs)
	Get the height for bottom-page QR invoice in mm, depending on the page number.

Private Member Functions
	getSwissQrBill (Facture $object, Translate $langs)
	Get the SwissQR object, including validation.

Detailed Description

Parent class of invoice document generators.

Definition at line 41 of file modules_facture.php.

Member Function Documentation

addBottomQRInvoice()

ModelePDFFactures::addBottomQRInvoice	(	TCPDF	$pdf,
		Facture	$object,
		Translate	$langs )

Add SwissQR invoice at bottom of page 1.

Parameters

TCPDF	$pdf	TCPDF object
Facture	$object	Invoice object
Translate	$langs	Translation object

Returns

bool True for for success

Definition at line 227 of file modules_facture.php.

References getSwissQrBill().

Referenced by pdf_crabe\write_file(), and pdf_sponge\write_file().

getHeightForQRInvoice()

ModelePDFFactures::getHeightForQRInvoice ( int $pagenbr, Facture $object, Translate $langs )

protected

Get the height for bottom-page QR invoice in mm, depending on the page number.

Parameters

int	$pagenbr	Page number
Facture	$object	Invoice object
Translate	$langs	Translation object

Returns

int Height in mm of the bottom-page QR invoice. Can be zero if not on right page; not enabled

Definition at line 199 of file modules_facture.php.

References getDolGlobalString(), and getSwissQrBill().

Referenced by pdf_sponge\drawTotalTable(), pdf_crabe\write_file(), pdf_octopus\write_file(), and pdf_sponge\write_file().

getSwissQrBill()

ModelePDFFactures::getSwissQrBill ( Facture $object, Translate $langs )

private

Get the SwissQR object, including validation.

Parameters

Facture	$object	Invoice object
Translate	$langs	Translation object

Returns

SwissQrBill\QrBill|bool The valid SwissQR object, or false

Definition at line 88 of file modules_facture.php.

References $object, and getDolGlobalString().

Referenced by addBottomQRInvoice(), and getHeightForQRInvoice().

liste_modeles()

static ModelePDFFactures::liste_modeles ( $db, $maxfilenamelength = 0 )

static

Return list of active generation modules.

Parameters

DoliDB	$db	Database handler
integer	$maxfilenamelength	Max length of value to show

Returns

array List of templates

Reimplemented in pdf_octopus, and pdf_sponge.

Definition at line 69 of file modules_facture.php.

References getListOfModels().

Referenced by migrate_modeles(), and FormFile\showdocuments().

---

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

• dolibarr_20.0/htdocs/core/modules/facture/modules_facture.php