dolibarr 20.0.0
pdf_canelle Class Reference

Class to generate the supplier invoices PDF with the template canelle. More...

Inheritance diagram for pdf_canelle:
Collaboration diagram for pdf_canelle:

Public Member Functions

 __construct ($db)
 Constructor.
 
 write_file ($object, $outputlangs=null, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto disk.
 
- 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.
 
 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_tot (&$pdf, $object, $deja_regle, $posy, $outputlangs)
 Show total to pay.
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines.
 
 _tableau_versements (&$pdf, $object, $posy, $outputlangs, $heightforfooter=0)
 Show payments table.
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs)
 Show top header of page.
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page.
 

Additional Inherited Members

- Static Public Member Functions inherited from ModelePDFSuppliersInvoices
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation models.
 

Detailed Description

Class to generate the supplier invoices PDF with the template canelle.

Definition at line 40 of file pdf_canelle.modules.php.

Constructor & Destructor Documentation

◆ __construct()

pdf_canelle::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 79 of file pdf_canelle.modules.php.

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

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
FactureFournisseur$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 1278 of file pdf_canelle.modules.php.

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

Referenced by write_file().

◆ _pagehead()

pdf_canelle::_pagehead ( & $pdf,
$object,
$showaddress,
$outputlangs )
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
FactureFournisseur$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
float|int Return topshift value

Definition at line 1040 of file pdf_canelle.modules.php.

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

Referenced by write_file().

◆ _tableau()

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

Show table for lines.

Parameters
TCPDF$pdfObject PDF
float | int$tab_topTop position of table
float | int$tab_heightHeight of table (rectangle)
int$nexYY (not used)
Translate$outputlangsLangs object
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 846 of file pdf_canelle.modules.php.

References getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRect().

Referenced by write_file().

◆ _tableau_tot()

pdf_canelle::_tableau_tot ( & $pdf,
$object,
$deja_regle,
$posy,
$outputlangs )
protected

Show total to pay.

Parameters
TCPDF$pdfObject PDF
FactureFournisseur$objectObject invoice
int$deja_regleAmount already paid (in the currency of invoice)
int$posyPosition depart
Translate$outputlangsObject langs
Returns
int Position of cursor after output

Definition at line 618 of file pdf_canelle.modules.php.

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

Referenced by write_file().

◆ _tableau_versements()

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

Show payments table.

Parameters
TCPDF$pdfObject PDF
Object$objectObject to show
int$posyPosition y in PDF
Translate$outputlangsObject langs for output
int$heightforfooterHeight for footer
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 948 of file pdf_canelle.modules.php.

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

Referenced by write_file().

◆ write_file()

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

Function to build pdf onto disk.

Parameters
FactureFournisseur$objectObject to generate
Translate$outputlangsLang output object
string$srctemplatepathFull path of source filename for generator using a template file
int$hidedetailsDo not show line details
int$hidedescDo not show desc
int$hiderefDo not show ref
Returns
int 1=OK, 0=KO

Definition at line 160 of file pdf_canelle.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), _tableau_tot(), _tableau_versements(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), get_exdir(), getDolGlobalInt(), getDolGlobalString(), make_substitutions(), pdf_getInstance(), pdf_getlineqty(), pdf_getlineremisepercent(), pdf_getlinetotalexcltax(), pdf_getlineunit(), pdf_getlineupexcltax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), and pdf_writelinedesc().


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