dolibarr 19.0.3
pdf_eagle Class Reference

Class to build sending documents with model Eagle. More...

Inheritance diagram for pdf_eagle:
Collaboration diagram for pdf_eagle:

Public Member Functions

 __construct ($db=0)
 Constructor.
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto disk.
 
 atLeastOneBatch ($object)
 
- 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_object ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
 
 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)
 Show table for lines.
 
 _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 ModelePDFStockTransfer
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules.
 

Detailed Description

Class to build sending documents with model Eagle.

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

Constructor & Destructor Documentation

◆ __construct()

pdf_eagle::__construct ( $db = 0)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 86 of file pdf_eagle.modules.php.

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

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

Parameters
PDF$pdfPDF
StockTransfer$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 1208 of file pdf_eagle.modules.php.

References getDolGlobalInt(), and pdf_pagefoot().

Referenced by write_file().

◆ _pagehead()

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

Show top header of page.

Parameters
TCPDF$pdfObject PDF
StockTransfer$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
void

Definition at line 937 of file pdf_eagle.modules.php.

References dol_print_date(), getDolGlobalString(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), and pdfBuildThirdpartyName().

Referenced by write_file().

◆ _tableau()

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

Show table for lines.

Parameters
TCPDF$pdfObject PDF
string$tab_topTop position of table
string$tab_heightHeight of table (rectangle)
int$nexYY
Translate$outputlangsLangs object
int$hidetopHide top bar of array
int$hidebottomHide bottom bar of array
Returns
void

Definition at line 820 of file pdf_eagle.modules.php.

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

Referenced by write_file().

◆ _tableau_tot()

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

Show total to pay.

Parameters
PDF$pdfObject PDF
StockTransfer$objectObject invoice
int$deja_regleMontant deja regle
int$posyPosition depart
Translate$outputlangsObjet langs
Returns
int Position pour suite

Definition at line 705 of file pdf_eagle.modules.php.

References getDolGlobalString(), pdf_getPDFFontSize(), price(), and showDimensionInBestUnit().

Referenced by write_file().

◆ atLeastOneBatch()

pdf_eagle::atLeastOneBatch ( $object)
 Used to know if at least one line of Stock Transfer object has a batch set

 @param StockTransfer $object Stock Transfer object
 @return  boolean     true if at least one line has batch set, false if not


Definition at line 908 of file pdf_eagle.modules.php.

Referenced by _tableau(), and write_file().

◆ write_file()

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

Function to build pdf onto disk.

Parameters
StockTransfer$objectObject StockTransfer to generate (or id if old method)
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 163 of file pdf_eagle.modules.php.

References _pagefoot(), _pagehead(), _tableau(), _tableau_tot(), atLeastOneBatch(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), get_exdir(), getDolGlobalInt(), getDolGlobalString(), measuringUnitString(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSizeForImage(), pdf_writelinedesc(), and price().


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