pdf_crabe Class Reference

Class to generate the customer invoice PDF with template Crabe. More...

Inheritance diagram for pdf_crabe:

Collaboration diagram for pdf_crabe:

Public Member Functions
	__construct ($db)
	Constructor.
	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build pdf onto disk.
Public Member Functions inherited from ModelePDFFactures
	addBottomQRInvoice (TCPDF $pdf, Facture $object, Translate $langs)
	Add SwissQR invoice at bottom of page 1.
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.
	getMaxAfterColsLinePositionsData ()
	Get position in PDF after col display.
	resetAfterColsLinePositionsData (float $y, int $pageNumb)
	Used for reset afterColsLinePositions var in start of a new pdf draw line loop.
	setAfterColsLinePositionsData (string $colId, float $y, int $pageNumb)
	Used for to set afterColsLinePositions var in a pdf draw line loop.
	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.

Protected Member Functions
	_tableau_versements (&$pdf, $object, $posy, $outputlangs, $heightforfooter=0)
	Show payments table.
	_tableau_versements_header ($pdf, $object, $outputlangs, $default_font_size, $tab3_posx, $tab3_top, $tab3_width, $tab3_height)
	Function _tableau_versements_header.
	_tableau_info (&$pdf, $object, $posy, $outputlangs, $outputlangsbis)
	Show miscellaneous information (payment mode, payment term, ...)
	_tableau_tot (&$pdf, $object, $deja_regle, $posy, $outputlangs, $outputlangsbis)
	Show total to pay.
	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.
	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $outputlangsbis=null)
	Show top header of page.
	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0, $heightforqrinvoice=0)
	Show footer of page.
Protected Member Functions inherited from ModelePDFFactures
	getHeightForQRInvoice (int $pagenbr, Facture $object, Translate $langs)
	Get the height for bottom-page QR invoice in mm, depending on the page number.

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

Detailed Description

Class to generate the customer invoice PDF with template Crabe.

Definition at line 49 of file pdf_crabe.modules.php.

Constructor & Destructor Documentation

__construct()

pdf_crabe::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Definition at line 103 of file pdf_crabe.modules.php.

References description, dol_syslog(), getCallerInfoString(), getDolGlobalInt(), getDolGlobalString(), name, pdf_getFormat(), and type.

Member Function Documentation

_pagefoot()

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

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Facture	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text
int	$heightforqrinvoice	Height for QR invoices

Returns

int Return height of bottom margin including footer text

Definition at line 2375 of file pdf_crabe.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

Referenced by write_file().

_pagehead()

pdf_crabe::_pagehead ( & $pdf, $object, $showaddress, $outputlangs, $outputlangsbis = null )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Facture	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output
Translate	$outputlangsbis	Object lang for output bis

Returns

float|int Return topshift value

Definition at line 1974 of file pdf_crabe.modules.php.

References $conf, $object, dol_print_date(), getDolGlobalInt(), getDolGlobalString(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_writeLinkedObjects(), and pdfBuildThirdpartyName().

Referenced by _tableau_versements(), and write_file().

_tableau()

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

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
float | int	$tab_top	Top position of table
float | int	$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

Returns

void

Definition at line 1857 of file pdf_crabe.modules.php.

References $conf, getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRoundedRect().

Referenced by write_file().

_tableau_info()

pdf_crabe::_tableau_info ( & $pdf, $object, $posy, $outputlangs, $outputlangsbis )

protected

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

Parameters

TCPDF	$pdf	Object PDF
Facture	$object	Object to show
int	$posy	Y
Translate	$outputlangs	Langs object
Translate	$outputlangsbis	Object lang for output bis

Returns

int Pos y

Definition at line 1162 of file pdf_crabe.modules.php.

References $object, dol_htmlentitiesbr(), dol_trunc(), dolBECalculateStructuredCommunication(), getDolGlobalInt(), getDolGlobalString(), pdf_bank(), pdf_getPDFFontSize(), price(), and Facture\STATUS_DRAFT.

Referenced by write_file().

_tableau_tot()

pdf_crabe::_tableau_tot ( & $pdf, $object, $deja_regle, $posy, $outputlangs, $outputlangsbis )

protected

Show total to pay.

Parameters

TCPDF	$pdf	Object PDF
Facture	$object	Object invoice
int	$deja_regle	Amount already paid (in the currency of invoice)
int	$posy	Position depart
Translate	$outputlangs	Object langs
Translate	$outputlangsbis	Object lang for output bis

Returns

int Position pour suite

Definition at line 1454 of file pdf_crabe.modules.php.

References $conf, $object, dol_print_date(), getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), pdfGetLineTotalDiscountAmount(), price(), price2num(), and vatrate().

Referenced by write_file().

_tableau_versements()

pdf_crabe::_tableau_versements ( & $pdf, $object, $posy, $outputlangs, $heightforfooter = 0 )

protected

Show payments table.

Parameters

TCPDF	$pdf	Object PDF
Facture	$object	Object invoice
int	$posy	Position y in PDF
Translate	$outputlangs	Object langs for output
int	$heightforfooter	Height for footer

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 963 of file pdf_crabe.modules.php.

References $object, _pagehead(), _tableau_versements_header(), dol_print_date(), getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), and price().

Referenced by write_file().

_tableau_versements_header()

pdf_crabe::_tableau_versements_header ( $pdf, $object, $outputlangs, $default_font_size, $tab3_posx, $tab3_top, $tab3_width, $tab3_height )

protected

Function _tableau_versements_header.

Parameters

TCPDF	$pdf	Object PDF
Facture	$object	Object invoice
Translate	$outputlangs	Object langs for output
int	$default_font_size	Font size
int	$tab3_posx	pos x
int	$tab3_top	pos y
int	$tab3_width	width
int	$tab3_height	height

Returns

void

Definition at line 1123 of file pdf_crabe.modules.php.

References $object.

Referenced by _tableau_versements().

write_file()

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

Function to build pdf onto disk.

Parameters

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

Returns

int<-1,1> 1=OK, <=0=KO

Reimplemented from ModelePDFFactures.

Definition at line 202 of file pdf_crabe.modules.php.

References $conf, $object, _pagefoot(), _pagehead(), _tableau(), _tableau_info(), _tableau_tot(), _tableau_versements(), ModelePDFFactures\addBottomQRInvoice(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), get_exdir(), getCountry(), getDolGlobalInt(), getDolGlobalString(), ModelePDFFactures\getHeightForQRInvoice(), getLocalTaxesFromRate(), make_substitutions(), pdf_getInstance(), pdf_getlineprogress(), pdf_getlineqty(), pdf_getlineremisepercent(), pdf_getlinetotalexcltax(), pdf_getlineunit(), pdf_getlineupexcltax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSizeForImage(), pdf_getSubstitutionArray(), pdf_writelinedesc(), setEventMessages(), Product\TYPE_PRODUCT, and Product\TYPE_SERVICE.

---

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

• dolibarr_dev/htdocs/core/modules/facture/doc/pdf_crabe.modules.php