pdf_eratosthene Class Reference

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

Inheritance diagram for pdf_eratosthene:

Collaboration diagram for pdf_eratosthene:

Public Member Functions
	__construct ($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_object ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
	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_shipment_lines ($line, $outputlangs)
	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=false, $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
	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.
	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $outputlangsbis=null, $titlekey="PdfOrderTitle")
	Show top header of page.
	_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 Eratosthene.

Definition at line 43 of file pdf_eratosthene.modules.php.

Constructor & Destructor Documentation

__construct()

pdf_eratosthene::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Reimplemented in pdf_proforma.

Definition at line 133 of file pdf_eratosthene.modules.php.

References description, getDolGlobalInt(), name, pdf_getFormat(), and type.

Member Function Documentation

_pagefoot()

pdf_eratosthene::_pagefoot ( & $pdf, $object, $outputlangs, $hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Commande	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns

int Return height of bottom margin including footer text

Definition at line 1739 of file pdf_eratosthene.modules.php.

References getDolGlobalInt(), and pdf_pagefoot().

Referenced by write_file().

_pagehead()

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

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

int Return topshift value

Reimplemented in pdf_proforma.

Definition at line 1461 of file pdf_eratosthene.modules.php.

References dol_print_date(), dol_trunc(), getDolGlobalInt(), getMultidirOutput(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_writeLinkedObjects(), and pdfBuildThirdpartyName().

Referenced by write_file().

_tableau()

pdf_eratosthene::_tableau ( & $pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop = 0, $hidebottom = 0, $currency = '', $outputlangsbis = null )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
string	$tab_top	Top position of table
string	$tab_height	Height of table (rectangle)
int	$nexY	Y (not used)
Translate	$outputlangs	Langs object
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code
Translate	$outputlangsbis	Langs object bis

Returns

void

Definition at line 1402 of file pdf_eratosthene.modules.php.

References pdf_getPDFFontSize(), CommonDocGenerator\pdfTabTitles(), and CommonDocGenerator\printRect().

Referenced by write_file().

defineColumnField()

pdf_eratosthene::defineColumnField	(		$object,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0 )

Define Array Column Field.

Parameters

Commande	$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 1758 of file pdf_eratosthene.modules.php.

References CommonDocGenerator\defineColumnExtrafield(), dol_string_nohtmltag(), dol_strlen(), getDolGlobalInt(), pdf_getlineupexcltax(), and setEventMessages().

drawInfoTable()

pdf_eratosthene::drawInfoTable ( & $pdf, $object, $posy, $outputlangs )

protected

Show miscellaneous information (payment mode, payment term, ...)

Parameters

TCPDF	$pdf	Object PDF
Commande	$object	Object to show
int	$posy	Y
Translate	$outputlangs	Langs object

Returns

int Pos y

Definition at line 944 of file pdf_eratosthene.modules.php.

References dol_print_date(), getDolGlobalInt(), pdf_bank(), and pdf_getPDFFontSize().

Referenced by write_file().

drawPaymentsTable()

pdf_eratosthene::drawPaymentsTable ( & $pdf, $object, $posy, $outputlangs )

protected

Show payments table.

Parameters

TCPDF	$pdf	Object PDF
Commande	$object	Object order
int	$posy	Position y in PDF
Translate	$outputlangs	Object langs for output

Returns

int <0 if KO, >0 if OK

Definition at line 930 of file pdf_eratosthene.modules.php.

drawTotalTable()

pdf_eratosthene::drawTotalTable ( & $pdf, $object, $deja_regle, $posy, $outputlangs, $outputlangsbis = null )

protected

Show total to pay.

Parameters

TCPDF	$pdf	Object PDF
Commande	$object	Object to show
int	$deja_regle	Montant deja regle
int	$posy	Position depart
Translate	$outputlangs	Objet langs
Translate	$outputlangsbis	Object lang for output bis

Returns

int Position pour suite

Definition at line 1127 of file pdf_eratosthene.modules.php.

References getDolGlobalString(), pdf_getPDFFontSize(), price(), price2num(), and vatrate().

Referenced by write_file().

write_file()

pdf_eratosthene::write_file	(		$object,
			$outputlangs,
			$srctemplatepath = '',
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0 )

Function to build pdf onto disk.

Parameters

Commande	$object	Object to generate
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns

int 1=OK, 0=KO

Definition at line 201 of file pdf_eratosthene.modules.php.

References _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), drawInfoTable(), drawTotalTable(), get_exdir(), CommonDocGenerator\getColumnContentXStart(), CommonDocGenerator\getColumnStatus(), getDolGlobalInt(), getDolGlobalString(), CommonDocGenerator\getExtrafieldContent(), getLocalTaxesFromRate(), getMultidirOutput(), make_substitutions(), pdf_getInstance(), pdf_getlineqty(), pdf_getlineremisepercent(), pdf_getlinetotalexcltax(), pdf_getlinetotalwithtax(), pdf_getlineunit(), pdf_getlineupexcltax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSizeForImage(), pdf_getSubstitutionArray(), CommonDocGenerator\pdfTabTitles(), CommonDocGenerator\prepareArrayColumnField(), CommonDocGenerator\printColDescContent(), and CommonDocGenerator\printStdColumnContent().

---

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

• dolibarr_18.0/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php