dolibarr 21.0.0-alpha
|
Class to manage PDF invoice template octopus. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0) | |
Function to build pdf onto disk. | |
drawPaymentsTable (&$pdf, $object, $posy, $outputlangs) | |
Show payments table. | |
defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0) | |
Define Array Column Field. | |
_tableFirstPage (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='') | |
Show table for lines. | |
sumSituation ($a, $b) | |
Calculates the sum of two arrays, key by key, taking into account nested arrays. | |
displayRetainedWarranty ($object) | |
Display retained Warranty. | |
getInfosLineLastSituation (&$object, &$current_line) | |
Get info line of the last situation. | |
printRectBtp (&$pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0) | |
Rect pdf. | |
![]() | |
addBottomQRInvoice (TCPDF $pdf, Facture $object, Translate $langs) | |
Add SwissQR invoice at bottom of page 1. | |
![]() | |
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. | |
Static Public Member Functions | |
static | liste_modeles ($db, $maxfilenamelength=0) |
Return list of active generation modules. | |
Protected Member Functions | |
drawInfoTable (&$pdf, $object, $posy, $outputlangs, $outputlangsbis) | |
Show miscellaneous information (payment mode, payment term, ...) | |
drawTotalTable (&$pdf, $object, $deja_regle, $posy, $outputlangs, $outputlangsbis) | |
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) | |
Show top header of page. | |
_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0) | |
Show footer of page. | |
![]() | |
getHeightForQRInvoice (int $pagenbr, Facture $object, Translate $langs) | |
Get the height for bottom-page QR invoice in mm, depending on the page number. | |
Class to manage PDF invoice template octopus.
Definition at line 49 of file pdf_octopus.modules.php.
pdf_octopus::__construct | ( | $db | ) |
Constructor.
Reimplemented from CommonDocGenerator.
Definition at line 176 of file pdf_octopus.modules.php.
References $object, description, dol_syslog(), getDolGlobalInt(), getDolGlobalString(), name, pdf_getFormat(), and type.
|
protected |
Show footer of page.
Need this->emetteur object
TCPDI | TCPDF | Object PDF | |
Facture | $object | Object to show |
Translate | $outputlangs | Object lang for output |
int | $hidefreetext | 1=Hide free text |
Definition at line 2434 of file pdf_octopus.modules.php.
References $object, getDolGlobalInt(), and pdf_pagefoot().
Referenced by write_file().
|
protected |
Show top header of page.
This include the logo, ref and address blocks
TCPDI | TCPDF | Object PDF | |
Facture | $object | Object to show |
int | $showaddress | 0=no, 1=yes (usually set to 1 for first page, and 0 for next pages) |
Translate | $outputlangs | Object lang for output |
Translate | $outputlangsbis | Object lang for output bis |
Definition at line 2045 of file pdf_octopus.modules.php.
References $object, dol_print_date(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_writeLinkedObjects(), and pdfBuildThirdpartyName().
Referenced by write_file().
|
protected |
Show table for lines.
TCPDI | TCPDF | Object PDF | |
int | $tab_top | Top position of table |
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 |
Translate | $outputlangsbis | Langs object bis |
Definition at line 1952 of file pdf_octopus.modules.php.
References CommonDocGenerator\getColumnStatus(), getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRect().
Referenced by write_file().
pdf_octopus::_tableFirstPage | ( | & | $pdf, |
$tab_top, | |||
$tab_height, | |||
$nexY, | |||
$outputlangs, | |||
$hidetop = 0, | |||
$hidebottom = 0, | |||
$currency = '' ) |
Show table for lines.
TCPDI | TCPDF | Object PDF | |
int | $tab_top | Top position of table |
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 2741 of file pdf_octopus.modules.php.
References $object, displayRetainedWarranty(), getDolGlobalString(), pdf_getPDFFontSize(), price(), and printRectBtp().
Referenced by write_file().
pdf_octopus::defineColumnField | ( | $object, | |
$outputlangs, | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0 ) |
Define Array Column Field.
Facture | $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 |
Reimplemented from CommonDocGenerator.
Definition at line 2450 of file pdf_octopus.modules.php.
References $object, dol_print_date(), dol_string_nohtmltag(), dol_strlen(), getDolGlobalInt(), getDolGlobalString(), pdf_getlineupexcltax(), and setEventMessages().
pdf_octopus::displayRetainedWarranty | ( | $object | ) |
Display retained Warranty.
Definition at line 3127 of file pdf_octopus.modules.php.
References $object, getDolGlobalString(), Facture\STATUS_DRAFT, and Facture\TYPE_SITUATION.
Referenced by _tableFirstPage().
|
protected |
Show miscellaneous information (payment mode, payment term, ...)
TCPDI | TCPDF | Object PDF | |
Facture | $object | Object to show |
int | $posy | Y |
Translate | $outputlangs | Langs object |
Translate | $outputlangsbis | Object lang for output bis |
Definition at line 1316 of file pdf_octopus.modules.php.
References $object, dol_htmlentitiesbr(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), pdf_bank(), pdf_getPDFFontSize(), and Facture\STATUS_DRAFT.
Referenced by write_file().
pdf_octopus::drawPaymentsTable | ( | & | $pdf, |
$object, | |||
$posy, | |||
$outputlangs ) |
Show payments table.
TCPDI | TCPDF | Object PDF | |
Facture | $object | Object invoice |
int | $posy | Position y in PDF |
Translate | $outputlangs | Object langs for output |
Definition at line 1171 of file pdf_octopus.modules.php.
References $object, dol_print_date(), getDolGlobalString(), pdf_getPDFFontSize(), and price().
Referenced by write_file().
|
protected |
Show total to pay.
TCPDI | TCPDF | 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 |
Definition at line 1548 of file pdf_octopus.modules.php.
References $object, dol_print_date(), getDolGlobalString(), pdf_getPDFFontSize(), price(), price2num(), and vatrate().
Referenced by write_file().
pdf_octopus::getInfosLineLastSituation | ( | & | $object, |
& | $current_line ) |
Get info line of the last situation.
Facture | $object | Object |
FactureLigne | $current_line | current line |
Definition at line 3172 of file pdf_octopus.modules.php.
References $object, and calcul_price_total().
Referenced by write_file().
|
static |
Return list of active generation modules.
Reimplemented from ModelePDFFactures.
Definition at line 1931 of file pdf_octopus.modules.php.
pdf_octopus::printRectBtp | ( | & | $pdf, |
$x, | |||
$y, | |||
$l, | |||
$h, | |||
$hidetop = 0, | |||
$hidebottom = 0 ) |
Rect pdf.
TCPDI | TCPDF | Object PDF | |
float | $x | Abscissa of first point |
float | $y | Ordinate of first point |
float | $l | ?? |
float | $h | ?? |
int | $hidetop | 1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title |
int | $hidebottom | Hide bottom |
Definition at line 3214 of file pdf_octopus.modules.php.
Referenced by _tableFirstPage().
pdf_octopus::sumSituation | ( | $a, | |
$b ) |
Calculates the sum of two arrays, key by key, taking into account nested arrays.
array | $a | [$a description] |
array | $b | [$b description] |
Definition at line 3100 of file pdf_octopus.modules.php.
References dol_syslog(), and sumSituation().
Referenced by sumSituation().
pdf_octopus::write_file | ( | $object, | |
$outputlangs, | |||
$srctemplatepath = '', | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0 ) |
Function to build pdf onto disk.
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 |
Reimplemented from ModelePDFFactures.
Definition at line 268 of file pdf_octopus.modules.php.
References $object, _pagefoot(), _pagehead(), _tableau(), _tableFirstPage(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), drawInfoTable(), drawPaymentsTable(), drawTotalTable(), get_exdir(), CommonDocGenerator\getColumnContentXStart(), CommonDocGenerator\getColumnStatus(), getCountry(), getDolGlobalInt(), getDolGlobalString(), ModelePDFFactures\getHeightForQRInvoice(), getInfosLineLastSituation(), getLocalTaxesFromRate(), make_substitutions(), pdf_getInstance(), pdf_getlineprogress(), pdf_getlineqty(), pdf_getlineremisepercent(), pdf_getlinetotalexcltax(), pdf_getlineunit(), pdf_getlineupexcltax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getSizeForImage(), pdf_getSubstitutionArray(), CommonDocGenerator\prepareArrayColumnField(), price(), CommonDocGenerator\printColDescContent(), CommonDocGenerator\printStdColumnContent(), setEventMessage(), Facture\TYPE_CREDIT_NOTE, Product\TYPE_PRODUCT, Product\TYPE_SERVICE, and Facture\TYPE_SITUATION.