pdf.lib.php File Reference

Set of functions used for PDF generation. More...

Go to the source code of this file.

Functions
	pdf_getFormat (Translate $outputlangs=null, $mode= 'setup')
	Return array with format properties of default PDF format. More...
	pdf_getInstance ($format= '', $metric= 'mm', $pagetype= 'P')
	Return a PDF instance object. More...
	pdf_getEncryption ($pathoffile)
	Return if pdf file is protected/encrypted. More...
	pdf_getPDFFont ($outputlangs)
	Return font name to use for PDF generation. More...
	pdf_getPDFFontSize ($outputlangs)
	Return font size to use for PDF generation. More...
	pdf_getHeightForLogo ($logo, $url=false)
	Return height to use for Logo onto PDF. More...
	pdfGetHeightForHtmlContent (&$pdf, $htmlcontent)
	Function to try to calculate height of a HTML Content. More...
	pdfBuildThirdpartyName ($thirdparty, Translate $outputlangs, $includealias=0)
	Returns the name of the thirdparty. More...
	pdf_build_address ($outputlangs, $sourcecompany, $targetcompany= '', $targetcontact= '', $usecontact=0, $mode= 'source', $object=null)
	Return a string with full address formated for output on documents. More...
	pdf_pagehead (&$pdf, $outputlangs, $page_height)
	Show header of page for PDF generation. More...
	pdf_getSubstitutionArray ($outputlangs, $exclude=null, $object=null, $onlykey=0)
	Return array of possible substitutions for PDF content (without external module substitutions). More...
	pdf_watermark (&$pdf, $outputlangs, $h, $w, $unit, $text)
	Add a draft watermark on PDF files. More...
	pdf_bank (&$pdf, $outputlangs, $curx, $cury, $account, $onlynumber=0, $default_font_size=10)
	Show bank informations for PDF generation. More...
	pdf_pagefoot (&$pdf, $outputlangs, $paramfreetext, $fromcompany, $marge_basse, $marge_gauche, $page_hauteur, $object, $showdetails=0, $hidefreetext=0)
	Show footer of page for PDF generation. More...
	pdf_writeLinkedObjects (&$pdf, $object, $outputlangs, $posx, $posy, $w, $h, $align, $default_font_size)
	Show linked objects for PDF generation. More...
	pdf_writelinedesc (&$pdf, $object, $i, $outputlangs, $w, $h, $posx, $posy, $hideref=0, $hidedesc=0, $issupplierline=0)
	Output line description into PDF. More...
	pdf_getlinedesc ($object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
	Return line description translated in outputlangs and encoded into htmlentities and with More...
	pdf_getlinenum ($object, $i, $outputlangs, $hidedetails=0)
	Return line num. More...
	pdf_getlineref ($object, $i, $outputlangs, $hidedetails=0)
	Return line product ref. More...
	pdf_getlineref_supplier ($object, $i, $outputlangs, $hidedetails=0)
	Return line ref_supplier. More...
	pdf_getlinevatrate ($object, $i, $outputlangs, $hidedetails=0)
	Return line vat rate. More...
	pdf_getlineupexcltax ($object, $i, $outputlangs, $hidedetails=0)
	Return line unit price excluding tax. More...
	pdf_getlineupwithtax ($object, $i, $outputlangs, $hidedetails=0)
	Return line unit price including tax. More...
	pdf_getlineqty ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity. More...
	pdf_getlineqty_asked ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity asked. More...
	pdf_getlineqty_shipped ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity shipped. More...
	pdf_getlineqty_keeptoship ($object, $i, $outputlangs, $hidedetails=0)
	Return line keep to ship quantity. More...
	pdf_getlineunit ($object, $i, $outputlangs, $hidedetails=0, $hookmanager=false)
	Return line unit. More...
	pdf_getlineremisepercent ($object, $i, $outputlangs, $hidedetails=0)
	Return line remise percent. More...
	pdf_getlineprogress ($object, $i, $outputlangs, $hidedetails=0, $hookmanager=null)
	Return line percent. More...
	pdf_getlinetotalexcltax ($object, $i, $outputlangs, $hidedetails=0)
	Return line total excluding tax. More...
	pdf_getlinetotalwithtax ($object, $i, $outputlangs, $hidedetails=0)
	Return line total including tax. More...
	pdf_getTotalQty ($object, $type, $outputlangs)
	Return total quantity of products and/or services. More...
	pdf_getLinkedObjects ($object, $outputlangs)
	Return linked objects to use for document generation. More...
	pdf_getSizeForImage ($realpath)
	Return dimensions to use for images onto PDF checking that width and height are not higher than maximum (16x32 by default). More...
	pdfGetLineTotalDiscountAmount ($object, $i, $outputlangs, $hidedetails=0)
	Return line total amount discount. More...

Detailed Description

Set of functions used for PDF generation.

Definition in file pdf.lib.php.

Function Documentation

pdf_bank	(	&	$pdf,
			$outputlangs,
			$curx,
			$cury,
			$account,
			$onlynumber = 0,
			$default_font_size = 10
	)

Show bank informations for PDF generation.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang
int	$curx	X
int	$cury	Y
Account	$account	Bank account object
int	$onlynumber	Output only number (bank+desk+key+number according to country, but without name of bank and domiciliation)
int	$default_font_size	Default font size

Returns

float The Y PDF position

Definition at line 712 of file pdf.lib.php.

References dol_print_error(), dol_strlen(), and FormBank\getIBANLabel().

Referenced by pdf_einstein\_tableau_info(), pdf_aurore\_tableau_info(), pdf_azur\_tableau_info(), pdf_crabe\_tableau_info(), pdf_eratosthene\drawInfoTable(), pdf_cyan\drawInfoTable(), pdf_sponge\drawInfoTable(), and BordereauChequeBlochet\Header().

pdf_build_address	(		$outputlangs,
			$sourcecompany,
			$targetcompany = '',
			$targetcontact = '',
			$usecontact = 0,
			$mode = 'source',
			$object = null
	)

Return a string with full address formated for output on documents.

Parameters

Translate	$outputlangs	Output langs object
Societe	$sourcecompany	Source company object
Societe | string | null	$targetcompany	Target company object
Contact | string | null	$targetcontact	Target contact object
int	$usecontact	Use contact instead of company
string	$mode	Address type ('source', 'target', 'targetwithdetails', 'targetwithdetails_xxx': target but include also phone/fax/email/url)
Object	$object	Object we want to build document for

Returns

string String with full address

Definition at line 376 of file pdf.lib.php.

References dol_format_address(), dol_string_nohtmltag(), and getState().

Referenced by pdf_merou\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_squille\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_canelle\_pagehead(), pdf_muscadet\_pagehead(), pdf_cornas\_pagehead(), pdf_aurore\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdf_getEncryption

(

$pathoffile

)

Return if pdf file is protected/encrypted.

Parameters

string

$pathoffile

Path of file

Returns

boolean True or false

Definition at line 191 of file pdf.lib.php.

pdf_getFormat	(	Translate	$outputlangs = null,
			$mode = 'setup'
	)

Return array with format properties of default PDF format.

Parameters

Translate	$outputlangs	Output lang to use to autodetect output format if we need 'auto' detection
string	$mode	'setup' = Use setup, 'auto' = Force autodetection whatever is setup

Returns

array Array('width'=>w,'height'=>h,'unit'=>u);

Definition at line 45 of file pdf.lib.php.

References $resql, dol_getDefaultFormat(), and dol_syslog().

Referenced by pdf_paiement\__construct(), pdf_squille\__construct(), BordereauChequeBlochet\__construct(), pdf_ban\__construct(), pdf_sepamandate\__construct(), pdf_timespent\__construct(), pdf_baleine\__construct(), pdf_beluga\__construct(), CommActionRapport\__construct(), pdf_espadon\__construct(), pdf_stdandard\__construct(), pdf_typhon\__construct(), pdf_merou\__construct(), pdf_rouget\__construct(), pdf_storm\__construct(), pdf_soleil\__construct(), pdf_aurore\__construct(), pdf_cornas\__construct(), pdf_muscadet\__construct(), pdf_canelle\__construct(), pdf_standard\__construct(), pdf_strato\__construct(), pdf_azur\__construct(), pdf_einstein\__construct(), pdf_cyan\__construct(), pdf_eratosthene\__construct(), pdf_crabe\__construct(), pdf_sponge\__construct(), pdf_standard_recruitmentjobposition\__construct(), pdf_standard_myobject\__construct(), and rebuild_merge_pdf().

pdf_getHeightForLogo	(		$logo,
			$url = false
	)

Return height to use for Logo onto PDF.

Parameters

string	$logo	Full path to logo file to use
bool	$url	Image with url (true or false)

Returns

number

Definition at line 270 of file pdf.lib.php.

References dol_getImageSize().

Referenced by pdf_ban\_pagehead(), pdf_merou\_pagehead(), pdf_baleine\_pagehead(), pdf_timespent\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_beluga\_pagehead(), pdf_squille\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_stdandard\_pagehead(), pdf_muscadet\_pagehead(), pdf_cornas\_pagehead(), pdf_aurore\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdf_getInstance	(		$format = '',
			$metric = 'mm',
			$pagetype = 'P'
	)

Return a PDF instance object.

We create a FPDI instance that instantiate TCPDF.

Parameters

string	$format	Array(width,height). Keep empty to use default setup.
string	$metric	Unit of format ('mm')
string	$pagetype	'P' or 'l'

Returns

TCPDF PDF object

Definition at line 88 of file pdf.lib.php.

References dol_mkdir().

Referenced by rebuild_merge_pdf(), BordereauChequeBlochet\write_file(), pdf_paiement\write_file(), pdf_ban\write_file(), pdf_sepamandate\write_file(), CommActionRapport\write_file(), pdf_squille\write_file(), pdf_baleine\write_file(), pdf_timespent\write_file(), pdf_beluga\write_file(), pdf_espadon\write_file(), pdf_merou\write_file(), pdf_soleil\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_cornas\write_file(), pdf_typhon\write_file(), pdf_rouget\write_file(), pdf_stdandard\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_aurore\write_file(), pdf_standard\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), pdf_crabe\write_file(), pdf_standardlabel\write_file(), and pdf_tcpdflabel\write_file().

pdf_getlinedesc	(		$object,
			$i,
			$outputlangs,
			$hideref = 0,
			$hidedesc = 0,
			$issupplierline = 0
	)

Return line description translated in outputlangs and encoded into htmlentities and with

Parameters

Object	$object	Object
int	$i	Current line number (0 = first line, 1 = second line, ...)
Translate	$outputlangs	Object langs for output
int	$hideref	Hide reference
int	$hidedesc	Hide description
int	$issupplierline	Is it a line for a supplier object ?

Returns

string String with line

Definition at line 1221 of file pdf.lib.php.

References dol_html_entity_decode(), dol_htmlentitiesbr(), dol_print_date(), and dol_textishtml().

Referenced by pdf_writelinedesc().

pdf_getlinenum	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line num.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1459 of file pdf.lib.php.

References dol_htmlentitiesbr().

pdf_getlineprogress	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0,
			$hookmanager = null
	)

Return line percent.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)
HookManager	$hookmanager	Hook manager instance

Returns

string

Definition at line 1906 of file pdf.lib.php.

Referenced by pdf_sponge\write_file(), and pdf_crabe\write_file().

pdf_getlineqty	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line quantity.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1691 of file pdf.lib.php.

Referenced by pdf_cornas\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_aurore\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getlineqty_asked	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line quantity asked.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1725 of file pdf.lib.php.

pdf_getlineqty_keeptoship	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line keep to ship quantity.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1793 of file pdf.lib.php.

pdf_getlineqty_shipped	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line quantity shipped.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1759 of file pdf.lib.php.

pdf_getlineref	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line product ref.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1492 of file pdf.lib.php.

References dol_htmlentitiesbr().

pdf_getlineref_supplier	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line ref_supplier.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1524 of file pdf.lib.php.

References dol_htmlentitiesbr().

pdf_getlineremisepercent	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line remise percent.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1869 of file pdf.lib.php.

References dol_print_reduction().

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getlinetotalexcltax	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line total excluding tax.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string Return total of line excl tax

Definition at line 1952 of file pdf.lib.php.

References price().

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getlinetotalwithtax	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line total including tax.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide value (0 = no, 1 = yes, 2 = just special lines)

Returns

string Return total of line incl tax

Definition at line 2009 of file pdf.lib.php.

References price().

Referenced by pdf_cyan\write_file(), pdf_eratosthene\write_file(), and pdf_sponge\write_file().

pdf_getlineunit	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0,
			$hookmanager = false
	)

Return line unit.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)
HookManager	$hookmanager	Hook manager instance

Returns

string Value for unit cell

Definition at line 1828 of file pdf.lib.php.

Referenced by pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_aurore\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getlineupexcltax	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line unit price excluding tax.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1615 of file pdf.lib.php.

References price().

Referenced by pdf_eratosthene\defineColumnField(), pdf_cyan\defineColumnField(), pdf_sponge\defineColumnField(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getlineupwithtax	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line unit price including tax.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide value (0 = no, 1 = yes, 2 = just special lines)

Returns

string

Definition at line 1655 of file pdf.lib.php.

References price().

pdf_getlinevatrate	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line vat rate.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

Definition at line 1556 of file pdf.lib.php.

References vatrate().

Referenced by pdf_standard\printLine(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_muscadet\write_file(), pdf_einstein\write_file(), pdf_azur\write_file(), and pdf_crabe\write_file().

pdf_getLinkedObjects	(		$object,
			$outputlangs
	)

Return linked objects to use for document generation.

Warning: To save space, this function returns only one link per link type (all links are concated on same record string). This function is used by pdf_writeLinkedObjects

Parameters

object	$object	Object
Translate	$outputlangs	Object lang for output

Returns

array Linked objects

Definition at line 2110 of file pdf.lib.php.

References dol_print_date().

Referenced by pdf_writeLinkedObjects().

pdf_getPDFFont

(

$outputlangs

)

Return font name to use for PDF generation.

Parameters

Translate

$outputlangs

Output langs object

Returns

string Name of font to use

Definition at line 222 of file pdf.lib.php.

Referenced by CommActionRapport\_pagehead(), pdf_pagefoot(), rebuild_merge_pdf(), BordereauChequeBlochet\write_file(), pdf_paiement\write_file(), pdf_ban\write_file(), pdf_sepamandate\write_file(), CommActionRapport\write_file(), pdf_squille\write_file(), pdf_baleine\write_file(), pdf_timespent\write_file(), pdf_beluga\write_file(), pdf_espadon\write_file(), pdf_merou\write_file(), pdf_soleil\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_cornas\write_file(), pdf_typhon\write_file(), pdf_rouget\write_file(), pdf_stdandard\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_sponge\write_file(), pdf_aurore\write_file(), pdf_standard\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), pdf_crabe\write_file(), pdf_standardlabel\write_file(), and pdf_tcpdflabel\write_file().

pdf_getPDFFontSize

(

$outputlangs

)

Return font size to use for PDF generation.

Parameters

Translate

$outputlangs

Output langs object

Returns

int Size of font to use

Definition at line 245 of file pdf.lib.php.

Referenced by pdf_merou\_pagefoot(), pdf_ban\_pagehead(), pdf_paiement\_pagehead(), pdf_merou\_pagehead(), pdf_baleine\_pagehead(), pdf_timespent\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_beluga\_pagehead(), pdf_squille\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_stdandard\_pagehead(), pdf_canelle\_pagehead(), pdf_muscadet\_pagehead(), pdf_cornas\_pagehead(), pdf_einstein\_pagehead(), pdf_aurore\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), pdf_sponge\_pagehead(), pdf_sepamandate\_signature_area(), pdf_azur\_signature_area(), pdf_ban\_tableau(), pdf_sepamandate\_tableau(), pdf_merou\_tableau(), pdf_baleine\_tableau(), pdf_timespent\_tableau(), pdf_soleil\_tableau(), pdf_strato\_tableau(), pdf_typhon\_tableau(), pdf_squille\_tableau(), pdf_storm\_tableau(), pdf_beluga\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), pdf_rouget\_tableau(), pdf_espadon\_tableau(), pdf_stdandard\_tableau(), pdf_standard_myobject\_tableau(), pdf_canelle\_tableau(), pdf_standard\_tableau(), pdf_muscadet\_tableau(), pdf_cornas\_tableau(), pdf_einstein\_tableau(), pdf_aurore\_tableau(), pdf_azur\_tableau(), pdf_eratosthene\_tableau(), pdf_cyan\_tableau(), pdf_crabe\_tableau(), pdf_sponge\_tableau(), pdf_standard\_tableau_cheque(), pdf_sepamandate\_tableau_info(), pdf_typhon\_tableau_info(), pdf_storm\_tableau_info(), pdf_einstein\_tableau_info(), pdf_muscadet\_tableau_info(), pdf_aurore\_tableau_info(), pdf_cornas\_tableau_info(), pdf_azur\_tableau_info(), pdf_crabe\_tableau_info(), pdf_squille\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_aurore\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_crabe\_tableau_tot(), pdf_crabe\_tableau_versements(), pdf_canelle\_tableau_versements(), BordereauChequeBlochet\Body(), pdf_paiement\Body(), pdf_eratosthene\drawInfoTable(), pdf_cyan\drawInfoTable(), pdf_sponge\drawInfoTable(), pdf_sponge\drawPaymentsTable(), pdf_cyan\drawSignatureArea(), pdf_eratosthene\drawTotalTable(), pdf_cyan\drawTotalTable(), pdf_sponge\drawTotalTable(), BordereauChequeBlochet\Header(), pdf_standard\tablePayments(), pdf_paiement\write_file(), pdf_ban\write_file(), pdf_sepamandate\write_file(), pdf_squille\write_file(), pdf_timespent\write_file(), pdf_baleine\write_file(), pdf_beluga\write_file(), pdf_espadon\write_file(), pdf_merou\write_file(), pdf_soleil\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_cornas\write_file(), pdf_typhon\write_file(), pdf_rouget\write_file(), pdf_stdandard\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_sponge\write_file(), pdf_aurore\write_file(), pdf_standard\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), pdf_einstein\write_file(), and pdf_crabe\write_file().

pdf_getSizeForImage

(

$realpath

)

Return dimensions to use for images onto PDF checking that width and height are not higher than maximum (16x32 by default).

Parameters

string

$realpath

Full path to photo file to use

Returns

array Height and width to use to output image (in pdf user unit, so mm)

Definition at line 2221 of file pdf.lib.php.

References dol_getImageSize().

Referenced by pdf_squille\write_file(), pdf_espadon\write_file(), pdf_storm\write_file(), pdf_cornas\write_file(), pdf_rouget\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_sponge\write_file(), pdf_aurore\write_file(), pdf_muscadet\write_file(), pdf_azur\write_file(), and pdf_crabe\write_file().

pdf_getSubstitutionArray	(		$outputlangs,
			$exclude = null,
			$object = null,
			$onlykey = 0
	)

Return array of possible substitutions for PDF content (without external module substitutions).

Parameters

Translate	$outputlangs	Output language
array	$exclude	Array of family keys we want to exclude. For example array('mycompany', 'object', 'date', 'user', ...)
Object	$object	Object
int	$onlykey	1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys), 2=Values are truncated and html sanitized (to use for help tooltip)

Returns

array Array of substitutions

Definition at line 643 of file pdf.lib.php.

References getCommonSubstitutionArray().

Referenced by BordereauChequeBlochet\_pagefoot(), pdf_pagefoot(), pdf_watermark(), pdf_baleine\write_file(), pdf_timespent\write_file(), pdf_beluga\write_file(), pdf_soleil\write_file(), pdf_cornas\write_file(), pdf_stdandard\write_file(), pdf_standard_myobject\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_canelle\write_file(), pdf_sponge\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_aurore\write_file(), pdf_standard\write_file(), pdf_einstein\write_file(), pdf_azur\write_file(), and pdf_crabe\write_file().

pdf_getTotalQty	(		$object,
			$type,
			$outputlangs
	)

Return total quantity of products and/or services.

Parameters

Object	$object	Object
string	$type	Type
Translate	$outputlangs	Object langs for output

Returns

integer

Deprecated:

Not used by Dolibarr core, so will be removed.

Definition at line 2066 of file pdf.lib.php.

pdf_pagefoot	(	&	$pdf,
			$outputlangs,
			$paramfreetext,
			$fromcompany,
			$marge_basse,
			$marge_gauche,
			$page_hauteur,
			$object,
			$showdetails = 0,
			$hidefreetext = 0
	)

Show footer of page for PDF generation.

Parameters

TCPDF	$pdf	The PDF factory
Translate	$outputlangs	Object lang for output
string	$paramfreetext	Constant name of free text
Societe	$fromcompany	Object company
int	$marge_basse	Margin bottom we use for the autobreak
int	$marge_gauche	Margin left (no more used)
int	$page_hauteur	Page height (no more used)
Object	$object	Object shown in PDF
int	$showdetails	Show company adress details into footer (0=Nothing, 1=Show address, 2=Show managers, 3=Both)
int	$hidefreetext	1=Hide free text, 0=Show free text

Returns

int Return height of bottom margin including footer text

Definition at line 887 of file pdf.lib.php.

References complete_substitutions_array(), dol_htmlentitiesbr(), getFormeJuridiqueLabel(), make_substitutions(), pdf_getPDFFont(), pdf_getSubstitutionArray(), pdfGetHeightForHtmlContent(), price(), and price2num().

Referenced by BordereauChequeBlochet\_pagefoot(), pdf_timespent\_pagefoot(), pdf_baleine\_pagefoot(), pdf_sepamandate\_pagefoot(), pdf_soleil\_pagefoot(), pdf_strato\_pagefoot(), pdf_beluga\_pagefoot(), pdf_typhon\_pagefoot(), pdf_storm\_pagefoot(), pdf_squille\_pagefoot(), pdf_standard_recruitmentjobposition\_pagefoot(), pdf_espadon\_pagefoot(), pdf_standard\_pagefoot(), pdf_rouget\_pagefoot(), pdf_standard_myobject\_pagefoot(), pdf_stdandard\_pagefoot(), pdf_canelle\_pagefoot(), pdf_muscadet\_pagefoot(), pdf_cornas\_pagefoot(), pdf_aurore\_pagefoot(), pdf_einstein\_pagefoot(), pdf_azur\_pagefoot(), pdf_eratosthene\_pagefoot(), pdf_cyan\_pagefoot(), pdf_crabe\_pagefoot(), and pdf_sponge\_pagefoot().

pdf_pagehead	(	&	$pdf,
			$outputlangs,
			$page_height
	)

Show header of page for PDF generation.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang for output
int	$page_height	Height of page

Returns

void

Definition at line 620 of file pdf.lib.php.

Referenced by pdf_ban\_pagehead(), pdf_merou\_pagehead(), pdf_baleine\_pagehead(), pdf_timespent\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_beluga\_pagehead(), pdf_squille\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_stdandard\_pagehead(), pdf_einstein\_pagehead(), pdf_aurore\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdf_watermark	(	&	$pdf,
			$outputlangs,
			$h,
			$w,
			$unit,
			$text
	)

Add a draft watermark on PDF files.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang
int	$h	Height of PDF
int	$w	Width of PDF
string	$unit	Unit of height (mm, pt, ...)
string	$text	Text to show

Returns

void

Definition at line 663 of file pdf.lib.php.

References complete_substitutions_array(), make_substitutions(), and pdf_getSubstitutionArray().

Referenced by pdf_merou\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_squille\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_stdandard\_pagehead(), pdf_aurore\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdf_writelinedesc	(	&	$pdf,
			$object,
			$i,
			$outputlangs,
			$w,
			$h,
			$posx,
			$posy,
			$hideref = 0,
			$hidedesc = 0,
			$issupplierline = 0
	)

Output line description into PDF.

Parameters

TCPDF	$pdf	PDF object
Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object lang for output
int	$w	Width
int	$h	Height
int	$posx	Pos x
int	$posy	Pos y
int	$hideref	Hide reference
int	$hidedesc	Hide description
int	$issupplierline	Is it a line for a supplier object ?

Returns

string

Definition at line 1174 of file pdf.lib.php.

References pdf_getlinedesc().

Referenced by CommonDocGenerator\printColDescContent(), pdf_squille\write_file(), pdf_merou\write_file(), pdf_storm\write_file(), pdf_typhon\write_file(), pdf_rouget\write_file(), pdf_standard\write_file(), pdf_stdandard\write_file(), pdf_canelle\write_file(), pdf_aurore\write_file(), pdf_muscadet\write_file(), pdf_einstein\write_file(), pdf_azur\write_file(), and pdf_crabe\write_file().

pdf_writeLinkedObjects	(	&	$pdf,
			$object,
			$outputlangs,
			$posx,
			$posy,
			$w,
			$h,
			$align,
			$default_font_size
	)

Show linked objects for PDF generation.

Parameters

TCPDF	$pdf	Object PDF
object	$object	Object
Translate	$outputlangs	Object lang
int	$posx	X
int	$posy	Y
float	$w	Width of cells. If 0, they extend up to the right margin of the page.
float	$h	Cell minimum height. The cell extends automatically if needed.
int	$align	Align
string	$default_font_size	Font size

Returns

float The Y PDF position

Definition at line 1135 of file pdf.lib.php.

References pdf_getLinkedObjects().

Referenced by pdf_merou\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_canelle\_pagehead(), pdf_muscadet\_pagehead(), pdf_cornas\_pagehead(), pdf_einstein\_pagehead(), pdf_aurore\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdfBuildThirdpartyName	(		$thirdparty,
		Translate	$outputlangs,
			$includealias = 0
	)

Returns the name of the thirdparty.

Parameters

Societe | Contact	$thirdparty	Contact or thirdparty
Translate	$outputlangs	Output language
int	$includealias	1=Include alias name after name

Returns

string String with name of thirdparty (+ alias if requested)

Definition at line 342 of file pdf.lib.php.

References Translate\convToOutputCharset().

Referenced by pdf_merou\_pagehead(), pdf_soleil\_pagehead(), pdf_strato\_pagehead(), pdf_standard\_pagehead(), pdf_typhon\_pagehead(), pdf_storm\_pagehead(), pdf_squille\_pagehead(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_canelle\_pagehead(), pdf_muscadet\_pagehead(), pdf_cornas\_pagehead(), pdf_einstein\_pagehead(), pdf_aurore\_pagehead(), pdf_eratosthene\_pagehead(), pdf_azur\_pagehead(), pdf_cyan\_pagehead(), pdf_crabe\_pagehead(), and pdf_sponge\_pagehead().

pdfGetHeightForHtmlContent	(	&	$pdf,
			$htmlcontent
	)

Function to try to calculate height of a HTML Content.

Parameters

TCPDF	$pdf	PDF initialized object
string	$htmlcontent	HTML Contect

Returns

int Height

See Also

getStringHeight()

Definition at line 294 of file pdf.lib.php.

Referenced by pdf_pagefoot(), pdf_cyan\write_file(), and pdf_azur\write_file().

pdfGetLineTotalDiscountAmount	(		$object,
			$i,
			$outputlangs,
			$hidedetails = 0
	)

Return line total amount discount.

Parameters

Object	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns

string Return total of line excl tax

Definition at line 2253 of file pdf.lib.php.

Referenced by pdf_sponge\drawTotalTable().