pdf_proforma Class Reference

Class to generate PDF orders with template Proforma. More...

Inheritance diagram for pdf_proforma:

Collaboration diagram for pdf_proforma:

Public Member Functions
	__construct ($db)
	Constructor.
Public Member Functions inherited from pdf_eratosthene
	__construct (DoliDB $db)
	Constructor.
	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build pdf onto disk.
	defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Define Array Column Field.
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.
	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.

Protected Member Functions
	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $outputlangsbis=null, $titlekey="InvoiceProForma")
	Show top header of page.
Protected Member Functions inherited from pdf_eratosthene
	drawPaymentsTable (&$pdf, $object, $posy, $outputlangs)
	Show payments table.
	drawInfoTable (&$pdf, $object, $posy, $outputlangs)
	Show miscellaneous information (payment mode, payment term, ...)
	drawTotalTable (&$pdf, $object, $deja_regle, $posy, $outputlangs, $outputlangsbis=null)
	Show total to pay.
	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='', $outputlangsbis=null)
	Show table for lines.
	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

Additional Inherited Members
Static Public Member Functions inherited from ModelePDFCommandes
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation modules.

Detailed Description

Class to generate PDF orders with template Proforma.

Definition at line 41 of file pdf_proforma.modules.php.

Constructor & Destructor Documentation

__construct()

pdf_proforma::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Definition at line 48 of file pdf_proforma.modules.php.

References $conf, description, and name.

Member Function Documentation

_pagehead()

pdf_proforma::_pagehead ( & $pdf, $object, $showaddress, $outputlangs, $outputlangsbis = null, $titlekey = "InvoiceProForma" )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Commande	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output
Translate	$outputlangsbis	Object lang for output bis
string	$titlekey	Translation key to show as title of document

Returns

array<string, int|float> top shift of linked object lines

Reimplemented from pdf_eratosthene.

Definition at line 72 of file pdf_proforma.modules.php.

References $object.

---

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

• dolibarr_dev/htdocs/core/modules/commande/doc/pdf_proforma.modules.php