dolibarr  17.0.3
Public Member Functions | Protected Member Functions | List of all members
pdf_eagle Class Reference

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

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

Public Member Functions

 __construct ($db=0)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto disk. More...
 
 atLeastOneBatch ($object)
  * Used to know if at least one line of Stock Transfer object has a batch set  * More...
 

Protected Member Functions

 _tableau_tot (&$pdf, $object, $deja_regle, $posy, $outputlangs)
 Show total to pay. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0)
 Show table for lines. More...
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs)
 Show top header of page. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 

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

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

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

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

◆ _pagehead()

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

Show top header of page.

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

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

◆ _tableau()

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

Show table for lines.

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

◆ _tableau_tot()

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

Show total to pay.

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

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

◆ atLeastOneBatch()

pdf_eagle::atLeastOneBatch (   $object)

 * Used to know if at least one line of Stock Transfer object has a batch set  *

Parameters
Object$objectStock Transfer object
Returns
boolean true if at least one line has batch set, false if not 

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

◆ write_file()

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

Function to build pdf onto disk.

Parameters
Object$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 194 of file pdf_eagle.modules.php.


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