dolibarr 21.0.0-alpha
pdf_octopus Class Reference

Class to manage PDF invoice template octopus. More...

Inheritance diagram for pdf_octopus:
Collaboration diagram for pdf_octopus:

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

Detailed Description

Class to manage PDF invoice template octopus.

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

Constructor & Destructor Documentation

◆ __construct()

pdf_octopus::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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.

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDI | TCPDF$pdfObject PDF
Facture$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 2435 of file pdf_octopus.modules.php.

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

Referenced by write_file().

◆ _pagehead()

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

Show top header of page.

This include the logo, ref and address blocks

Parameters
TCPDI | TCPDF$pdfObject PDF
Facture$objectObject to show
int$showaddress0=no, 1=yes (usually set to 1 for first page, and 0 for next pages)
Translate$outputlangsObject lang for output
Translate$outputlangsbisObject lang for output bis
Returns
array top shift of linked object lines

Definition at line 2046 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().

◆ _tableau()

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

Show table for lines.

Parameters
TCPDI | TCPDF$pdfObject PDF
int$tab_topTop position of table
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
Translate$outputlangsbisLangs object bis
Returns
void

Definition at line 1953 of file pdf_octopus.modules.php.

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

Referenced by write_file().

◆ _tableFirstPage()

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

Show table for lines.

Parameters
TCPDI | TCPDF$pdfObject PDF
int$tab_topTop position of table
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 2742 of file pdf_octopus.modules.php.

References $object, displayRetainedWarranty(), getDolGlobalString(), pdf_getPDFFontSize(), price(), and printRectBtp().

Referenced by write_file().

◆ defineColumnField()

pdf_octopus::defineColumnField ( $object,
$outputlangs,
$hidedetails = 0,
$hidedesc = 0,
$hideref = 0 )

Define Array Column Field.

Parameters
Facture$objectcommon object
Translate$outputlangslangs
int$hidedetailsDo not show line details
int$hidedescDo not show desc
int$hiderefDo not show ref
Returns
void

Reimplemented from CommonDocGenerator.

Definition at line 2451 of file pdf_octopus.modules.php.

References $object, dol_print_date(), dol_string_nohtmltag(), dol_strlen(), getDolGlobalInt(), getDolGlobalString(), pdf_getlineupexcltax(), and setEventMessages().

◆ displayRetainedWarranty()

pdf_octopus::displayRetainedWarranty ( $object)

Display retained Warranty.

Parameters
Facture$objectFacture
Returns
bool

Definition at line 3128 of file pdf_octopus.modules.php.

References $object, getDolGlobalString(), Facture\STATUS_DRAFT, and Facture\TYPE_SITUATION.

Referenced by _tableFirstPage().

◆ drawInfoTable()

pdf_octopus::drawInfoTable ( & $pdf,
$object,
$posy,
$outputlangs,
$outputlangsbis )
protected

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

Parameters
TCPDI | TCPDF$pdfObject PDF
Facture$objectObject to show
int$posyY
Translate$outputlangsLangs object
Translate$outputlangsbisObject lang for output bis
Returns
int Pos y

Definition at line 1317 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().

◆ drawPaymentsTable()

pdf_octopus::drawPaymentsTable ( & $pdf,
$object,
$posy,
$outputlangs )

Show payments table.

Parameters
TCPDI | TCPDF$pdfObject PDF
Facture$objectObject invoice
int$posyPosition y in PDF
Translate$outputlangsObject langs for output
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1172 of file pdf_octopus.modules.php.

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

Referenced by write_file().

◆ drawTotalTable()

pdf_octopus::drawTotalTable ( & $pdf,
$object,
$deja_regle,
$posy,
$outputlangs,
$outputlangsbis )
protected

Show total to pay.

Parameters
TCPDI | TCPDF$pdfObject PDF
Facture$objectObject invoice
int$deja_regleAmount already paid (in the currency of invoice)
int$posyPosition depart
Translate$outputlangsObject langs
Translate$outputlangsbisObject lang for output bis
Returns
int Position pour suite

Definition at line 1549 of file pdf_octopus.modules.php.

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

Referenced by write_file().

◆ getInfosLineLastSituation()

pdf_octopus::getInfosLineLastSituation ( & $object,
& $current_line )

Get info line of the last situation.

Parameters
Facture$objectObject
FactureLigne$current_linecurrent line
Returns
void|array{progress_prec:float,total_ht_without_progress:float,total_ht:float}

Definition at line 3173 of file pdf_octopus.modules.php.

References $object, and calcul_price_total().

Referenced by write_file().

◆ liste_modeles()

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

Return list of active generation modules.

Parameters
DoliDB$dbDatabase handler
int<0,max>$maxfilenamelength Max length of value to show
Returns
string[]|int<-1,0> List of templates

Reimplemented from ModelePDFFactures.

Definition at line 1932 of file pdf_octopus.modules.php.

◆ printRectBtp()

pdf_octopus::printRectBtp ( & $pdf,
$x,
$y,
$l,
$h,
$hidetop = 0,
$hidebottom = 0 )

Rect pdf.

Parameters
TCPDI | TCPDF$pdfObject PDF
float$xAbscissa of first point
float$yOrdinate of first point
float$l??
float$h??
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom
Returns
void

Definition at line 3215 of file pdf_octopus.modules.php.

Referenced by _tableFirstPage().

◆ sumSituation()

pdf_octopus::sumSituation ( $a,
$b )

Calculates the sum of two arrays, key by key, taking into account nested arrays.

Parameters
array$a[$a description]
array$b[$b description]
Returns
array [return description]

Definition at line 3101 of file pdf_octopus.modules.php.

References dol_syslog(), and sumSituation().

Referenced by sumSituation().

◆ write_file()

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

Function to build pdf onto disk.

Parameters
Facture$objectObject to generate
Translate$outputlangsLang output object
string$srctemplatepathFull 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 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.


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