dolibarr 20.0.0
|
Class to generate the supplier invoices PDF with the template canelle. More...
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. | |
Class to generate the supplier invoices PDF with the template canelle.
Definition at line 40 of file pdf_canelle.modules.php.
pdf_canelle::__construct | ( | $db | ) |
Constructor.
Reimplemented from CommonDocGenerator.
Definition at line 79 of file pdf_canelle.modules.php.
References description, getDolGlobalInt(), name, pdf_getFormat(), and type.
|
protected |
Show footer of page.
Need this->emetteur object
TCPDF | ||
FactureFournisseur | $object | Object to show |
Translate | $outputlangs | Object lang for output |
int | $hidefreetext | 1=Hide free text |
Definition at line 1278 of file pdf_canelle.modules.php.
References $object, getDolGlobalInt(), and pdf_pagefoot().
Referenced by write_file().
|
protected |
Show top header of page.
TCPDF | Object PDF | |
FactureFournisseur | $object | Object to show |
int | $showaddress | 0=no, 1=yes |
Translate | $outputlangs | Object lang for output |
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().
|
protected |
Show table for lines.
TCPDF | 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 |
Definition at line 846 of file pdf_canelle.modules.php.
References getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRect().
Referenced by write_file().
|
protected |
Show total to pay.
TCPDF | Object PDF | |
FactureFournisseur | $object | Object invoice |
int | $deja_regle | Amount already paid (in the currency of invoice) |
int | $posy | Position depart |
Translate | $outputlangs | Object langs |
Definition at line 618 of file pdf_canelle.modules.php.
References $object, getDolGlobalString(), pdf_getPDFFontSize(), price(), price2num(), and vatrate().
Referenced by write_file().
|
protected |
Show payments table.
TCPDF | Object PDF | |
Object | $object | Object to show |
int | $posy | Position y in PDF |
Translate | $outputlangs | Object langs for output |
int | $heightforfooter | Height for footer |
Definition at line 948 of file pdf_canelle.modules.php.
References $object, dol_print_date(), getDolGlobalString(), pdf_getPDFFontSize(), and price().
Referenced by write_file().
pdf_canelle::write_file | ( | $object, | |
$outputlangs = null, | |||
$srctemplatepath = '', | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0 ) |
Function to build pdf onto disk.
FactureFournisseur | $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 |
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().