dolibarr  21.0.0-alpha
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
ModelePDFFactures Class Reference

Parent class of invoice document generators. More...

Inheritance diagram for ModelePDFFactures:
Inheritance graph
[legend]
Collaboration diagram for ModelePDFFactures:
Collaboration graph
[legend]

Public Member Functions

 addBottomQRInvoice (TCPDF $pdf, Facture $object, Translate $langs)
 Add SwissQR invoice at bottom of page 1. More...
 
- Public Member Functions inherited from CommonDocGenerator
 __construct ($db)
 Constructor. More...
 
 get_substitutionarray_user ($user, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 getSubstitutionarrayMember ($member, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_mysoc ($mysoc, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
 Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}. More...
 
 get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_other ($outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
 Define array with couple substitution key => substitution value. More...
 
 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. More...
 
 printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
 Rect pdf. More...
 
 columnSort ($a, $b)
 uasort callback function to Sort columns fields More...
 
 prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Prepare Array Column Field. More...
 
 getColumnContentWidth ($colKey)
 get column content width from column key More...
 
 getColumnContentXStart ($colKey)
 get column content X (abscissa) left position from column key More...
 
 getColumnRank ($colKey)
 get column position rank from column key More...
 
 insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false)
 get column position rank from column key More...
 
 printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
 print standard column content More...
 
 printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
 print description column content More...
 
 getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
 get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block More...
 
 getColumnStatus ($colKey)
 get column status from column key More...
 
 pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
 Print standard column content. More...
 
 defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
 Define Array Column Field for extrafields. More...
 
 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. More...
 

Static Public Member Functions

static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules. More...
 

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. More...
 

Private Member Functions

 getSwissQrBill (Facture $object, Translate $langs)
 Get the SwissQR object, including validation. More...
 

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$pdfTCPDF object
Facture$objectInvoice object
Translate$langsTranslation object
Returns
bool True for for success

Definition at line 227 of file modules_facture.php.

◆ 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$pagenbrPage number
Facture$objectInvoice object
Translate$langsTranslation 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.

◆ getSwissQrBill()

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

Get the SwissQR object, including validation.

Parameters
Facture$objectInvoice object
Translate$langsTranslation object
Returns
SwissQrBill\QrBill|bool The valid SwissQR object, or false

Definition at line 88 of file modules_facture.php.

◆ liste_modeles()

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

Return list of active generation modules.

Parameters
DoliDB$dbDatabase handler
integer$maxfilenamelengthMax length of value to show
Returns
array List of templates

Reimplemented in pdf_sponge, and pdf_octopus.

Definition at line 69 of file modules_facture.php.


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