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

pdf_eagle::__construct

(

$db = 0

)

Constructor.

Parameters

DoliDB

$db

Database handler

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

References db, description, name, pdf_getFormat(), and type.

Member Function Documentation

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

protected

Show footer of page.

Need this->emetteur object

Parameters

PDF	$pdf	PDF
Object	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns

int Return height of bottom margin including footer text

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

References pdf_pagefoot().

Referenced by write_file().

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

protected

Show top header of page.

Parameters

PDF	$pdf	Object PDF
Object	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output

Returns

void

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

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

Referenced by write_file().

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

protected

Show table for lines.

Parameters

PDF	$pdf	Object PDF
string	$tab_top	Top position of table
string	$tab_height	Height of table (rectangle)
int	$nexY	Y
Translate	$outputlangs	Langs object
int	$hidetop	Hide top bar of array
int	$hidebottom	Hide bottom bar of array

Returns

void

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

References pdf_getPDFFontSize().

Referenced by write_file().

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

protected

Show total to pay.

Parameters

PDF	$pdf	Object PDF
Facture	$object	Object invoice
int	$deja_regle	Montant deja regle
int	$posy	Position depart
Translate	$outputlangs	Objet langs

Returns

int Position pour suite

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

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

Referenced by write_file().

pdf_eagle::atLeastOneBatch

(

$object

)

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

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



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

Referenced by write_file().

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

Function to build pdf onto disk.

Parameters

Object	$object	Object StockTransfer to generate (or id if old method)
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

Returns

int 1=OK, 0=KO

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

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

---

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

• htdocs/core/modules/stocktransfer/doc/pdf_eagle.modules.php