pdf.lib.php File Reference

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

Go to the source code of this file.

Functions
	pdf_admin_prepare_head ()
	Return array head with list of tabs to view object information.
	pdf_getFormat ($outputlangs=null, $mode='setup')
	Return array with format properties of default PDF format.
	pdf_getInstance ($format='', $metric='mm', $pagetype='P')
	Return a PDF instance object.
	pdf_getEncryption ($pathoffile)
	Return if pdf file is protected/encrypted.
	pdf_getPDFFont ($outputlangs)
	Return font name to use for PDF generation.
	pdf_getPDFFontSize ($outputlangs)
	Return font size to use for PDF generation.
	pdf_getHeightForLogo ($logo, $url=false)
	Return height to use for Logo onto PDF.
	pdfGetHeightForHtmlContent ($pdf, $htmlcontent)
	Function to try to calculate height of a HTML Content.
	pdfBuildThirdpartyName ($thirdparty, Translate $outputlangs, $includealias=0)
	Returns the name of the thirdparty.
	pdf_build_address ($outputlangs, $sourcecompany, $targetcompany='', $targetcontact='', $usecontact=0, $mode='source', $object=null)
	Return a string with full address formatted for output on PDF documents.
	pdf_pagehead ($pdf, $outputlangs, $page_height)
	Show header of page for PDF generation.
	pdfWriteAdditionnalTitle ($pdf, $outputlangs, $page_height, $object, &$w, &$posx, &$posy)
	Add some information from the blockedlog module.
	pdfWriteVATArray ($docgenerator, &$index, $pdf, $outputlangs, $outputlangsbis, $object, $col1x, $col2x, $largcol2, $tab2_top, $tab2_hl)
	Add some information from the blockedlog module.
	pdfWriteAlreadyPaid ($docgenerator, &$index, $pdf, $outputlangs, $outputlangsbis, $object, $col1x, $col2x, $largcol2, $tab2_top, $tab2_hl, $deja_regle, $creditnoteamount, $depositsamount, $resteapayer, $resteapayer_origin)
	Add some information from the blockedlog module.
	pdf_getSubstitutionArray ($outputlangs, $exclude=null, $object=null, $onlykey=0, $include=null)
	Return array of possible substitutions for PDF content (without external module substitutions).
	pdf_watermark ($pdf, $outputlangs, $h, $w, $unit, $text)
	Add a draft watermark on PDF files.
	pdfCertifMention ($pdf, $outputlangs, $seller, $default_font_size, &$posy, $pdftemplate)
	Add legal certificate mention.
	pdf_bank ($pdf, $outputlangs, $curx, $cury, $account, $onlynumber=0, $default_font_size=10)
	Show bank information for PDF generation.
	pdf_pagefoot ($pdf, $outputlangs, $paramfreetext, $fromcompany, $marge_basse, $marge_gauche, $page_hauteur, $object, $showdetails=0, $hidefreetext=0, $page_largeur=0, $watermark='')
	Show footer of page for PDF generation.
	pdf_writeLinkedObjects ($pdf, $object, $outputlangs, $posx, $posy, $w, $h, $align, $default_font_size)
	Show linked objects for PDF generation.
	pdf_writelinedesc ($pdf, $object, $i, $outputlangs, $w, $h, $posx, $posy, $hideref=0, $hidedesc=0, $issupplierline=0, $align='J')
	Output line description into PDF.
	pdf_getlinedesc ($object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
	Return line description translated in outputlangs and encoded into htmlentities and with
	pdf_getlinenum ($object, $i, $outputlangs, $hidedetails=0)
	Return line num.
	pdf_getlineref ($object, $i, $outputlangs, $hidedetails=0)
	Return line product ref.
	pdf_getlineref_supplier ($object, $i, $outputlangs, $hidedetails=0)
	Return line ref_supplier.
	pdf_getlinevatrate ($object, $i, $outputlangs, $hidedetails=0)
	Return line vat rate.
	pdf_getlineupexcltax ($object, $i, $outputlangs, $hidedetails=0)
	Return line unit price excluding tax.
	pdf_getlineupwithtax ($object, $i, $outputlangs, $hidedetails=0)
	Return line unit price including tax.
	pdf_getlineqty ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity.
	pdf_getlineqty_asked ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity asked.
	pdf_getlineqty_shipped ($object, $i, $outputlangs, $hidedetails=0)
	Return line quantity shipped.
	pdf_getlineqty_keeptoship ($object, $i, $outputlangs, $hidedetails=0)
	Return line keep to ship quantity.
	pdf_getlineunit ($object, $i, $outputlangs, $hidedetails=0)
	Return line unit.
	pdf_getlineremisepercent ($object, $i, $outputlangs, $hidedetails=0)
	Return line remise percent.
	pdf_getlineprogress ($object, $i, $outputlangs, $hidedetails=0, $hookmanager=null)
	Return line percent.
	pdf_getlinetotalexcltax ($object, $i, $outputlangs, $hidedetails=0)
	Return line total excluding tax.
	pdf_getlinetotalwithtax ($object, $i, $outputlangs, $hidedetails=0)
	Return line total including tax.
	canDisplayLinkedObjectInPDF ($object, $elementobject)
	Check if a linked object can be displayed based on third-party privacy rules.
	pdf_getSizeForImage ($realpath)
	Return dimensions to use for images onto PDF checking that width and height are not higher than maximum (20x32 by default).
	pdfGetLineTotalDiscountAmount ($object, $i, $outputlangs, $hidedetails=0, $multicurrency=0)
	Return line total amount discount.
	pdfExtractMetadata ($file, $field='Keywords')
	Function to extract metadata from a PDF file by doing a binary parsing of the PDF file.
	pdf_render_subtotals (TCPDF $pdf, CommonDocGenerator $generator, float $curY, CommonObject $object, int $i, Translate $outputlangs, int $hideref, int $hidedesc, array $bgColor, bool $isSubtotal=false, bool $applySubtotalLogic=true)
	Render subtotals line with a colored background and adapted text color .

Detailed Description

Set of functions used for PDF generation.

Definition in file pdf.lib.php.

Function Documentation

canDisplayLinkedObjectInPDF()

canDisplayLinkedObjectInPDF	(		$object,
			$elementobject )

Check if a linked object can be displayed based on third-party privacy rules.

This function prevents displaying customer data to suppliers or supplier data to customers according to the configuration and the socid of the main object and the linked object.

Parameters

object	$object	The main Dolibarr object (e.g., invoice, order, proposal)
object	$elementobject	The linked object to check (e.g., linked order, linked invoice)

Returns

bool Returns true if the linked object can be displayed, false otherwise.

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

References $object, getDolGlobalBool(), and getObjectSocId().

pdf_admin_prepare_head()

pdf_admin_prepare_head

(

)

Return array head with list of tabs to view object information.

Returns

array<array{0:string,1:string,2:string}> head array with tabs

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

References $conf, complete_head_from_modules(), and isModEnabled().

pdf_bank()

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

Show bank information for PDF generation.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang
float	$curx	X
float	$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 address)
int	$default_font_size	Default font size

Returns

float The Y PDF position

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

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

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

pdf_build_address()

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

Return a string with full address formatted for output on PDF 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)
?CommonObject	$object	Object we want to build document for

Returns

string|int String with full address or -1 if KO

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

References $object, dol_format_address(), dol_string_nohtmltag(), getDolGlobalInt(), getDolGlobalString(), getFormeJuridiqueLabel(), and getState().

Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_rouget\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_salary\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), and pdf_zenith\_pagehead().

pdf_getEncryption()

pdf_getEncryption

(

$pathoffile

)

Return if pdf file is protected/encrypted.

Parameters

string

$pathoffile

Path of file

Returns

boolean True or false

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

pdf_getFormat()

pdf_getFormat	(		$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
	'setup'|'auto'	$mode 'setup' = Use setup, 'auto' = Force autodetection whatever is setup

Returns

array{width:float|int,height:float|int,unit:string} Array('width'=>w,'height'=>h,'unit'=>u);

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

References $conf, $db, dol_getDefaultFormat(), dol_syslog(), and getDolGlobalString().

Referenced by BordereauChequeBlochet\__construct(), pdf_aurore\__construct(), pdf_azur\__construct(), pdf_balance\__construct(), pdf_baleine\__construct(), pdf_ban\__construct(), pdf_beluga\__construct(), pdf_bookkeeping\__construct(), pdf_canelle\__construct(), pdf_cornas\__construct(), pdf_cyan\__construct(), pdf_eagle\__construct(), pdf_eagle_proforma\__construct(), pdf_einstein\__construct(), pdf_eratosthene\__construct(), pdf_espadon\__construct(), pdf_ledger\__construct(), pdf_merou\__construct(), pdf_muscadet\__construct(), pdf_octopus\__construct(), pdf_paiement\__construct(), pdf_rouget\__construct(), pdf_sepamandate\__construct(), pdf_soleil\__construct(), pdf_sponge\__construct(), pdf_squille\__construct(), pdf_standard\__construct(), pdf_standard_actions\__construct(), pdf_standard_asset\__construct(), pdf_standard_evaluation\__construct(), pdf_standard_expensereport\__construct(), pdf_standard_movementstock\__construct(), pdf_standard_myobject\__construct(), pdf_standard_recruitmentjobposition\__construct(), pdf_standard_salary\__construct(), pdf_standard_stock\__construct(), pdf_standard_supplierpayment\__construct(), pdf_storm\__construct(), pdf_strato\__construct(), pdf_timespent\__construct(), pdf_typhon\__construct(), pdf_vinci\__construct(), pdf_zenith\__construct(), and rebuild_merge_pdf().

pdf_getHeightForLogo()

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

float

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

References dol_getImageSize(), and getDolGlobalFloat().

Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_rouget\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_evaluation\_pagehead(), pdf_standard_expensereport\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_salary\_pagehead(), pdf_standard_stock\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_timespent\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), and pdf_zenith\_pagehead().

pdf_getInstance()

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

Return a PDF instance object.

We create a FPDI instance that instantiate TCPDF.

Parameters

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

Returns

TCPDF|TCPDI PDF object

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

References $conf, dol_mkdir(), getDolGlobalInt(), and getDolGlobalString().

Referenced by rebuild_merge_pdf(), BordereauChequeBlochet\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_standardlabel\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_tcpdflabel\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), and pdf_standard_salary\writeFile().

pdf_getlinedesc()

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

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

Parameters

CommonObject	$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 1905 of file pdf.lib.php.

References $conf, $db, $object, dol_concatdesc(), dol_html_entity_decode(), dol_htmlentitiesbr(), dol_now(), dol_print_date(), dol_textishtml(), getDolGlobalInt(), getDolGlobalString(), and isModEnabled().

Referenced by pdf_writelinedesc().

pdf_getlinenum()

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

Return line num.

Parameters

CommonObject	$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 2306 of file pdf.lib.php.

References $object, and dol_htmlentitiesbr().

pdf_getlineprogress()

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

Return line percent.

Parameters

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

Returns

string

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

References $object, and getDolGlobalInt().

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

pdf_getlineqty()

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

Return line quantity.

Parameters

Delivery | Asset | Commande | Facture | CommandeFournisseur | FactureFournisseur | SupplierProposal | Propal | StockTransfer | MyObject	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $object.

Referenced by pdf_aurore\write_file(), pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), and pdf_zenith\write_file().

pdf_getlineqty_asked()

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

Return line quantity asked.

Parameters

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

Returns

string

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

References $object.

pdf_getlineqty_keeptoship()

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

Return line keep to ship quantity.

Parameters

Delivery | Asset | Commande | Facture | CommandeFournisseur | FactureFournisseur | SupplierProposal | Propal | StockTransfer | MyObject	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $object.

pdf_getlineqty_shipped()

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

Return line quantity shipped.

Parameters

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

Returns

string

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

References $object.

pdf_getlineref()

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

Return line product ref.

Parameters

CommonObject	$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 2339 of file pdf.lib.php.

References $object, and dol_htmlentitiesbr().

pdf_getlineref_supplier()

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

Return line ref_supplier.

Parameters

Contrat | CommandeFournisseur | FactureFournisseur | Facture | Product | Reception | SupplierProposal	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $object, and dol_htmlentitiesbr().

pdf_getlineremisepercent()

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

Return line remise percent.

Parameters

SupplierProposal | CommandeFournisseur | Propal | Facture | FactureFournisseur | Commande | StockTransfer	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $object, and dol_print_reduction().

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

pdf_getlinetotalexcltax()

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

Return line total excluding tax.

Parameters

Commande | Facture | Propal | FactureFournisseur | CommandeFournisseur | SupplierProposal	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string Return total of line excl tax

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

References $object, getDolGlobalString(), isModEnabled(), and price().

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

pdf_getlinetotalwithtax()

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

Return line total including tax.

Parameters

Commande | Facture | Propal | FactureFournisseur | CommandeFournisseur | SupplierProposal	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)

Returns

string Return total of line incl tax

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

References $object, getDolGlobalString(), isModEnabled(), and price().

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

pdf_getlineunit()

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

Return line unit.

Parameters

SupplierProposal | CommandeFournisseur | Propal | Facture | FactureFournisseur | Commande | StockTransfer	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string Value for unit cell

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

References $object.

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

pdf_getlineupexcltax()

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

Return line unit price excluding tax.

Parameters

CommonObject | SupplierProposal | CommandeFournisseur | Propal | Facture | FactureFournisseur | Commande | StockTransfer	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $object, getDolGlobalString(), isModEnabled(), and price().

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

pdf_getlineupwithtax()

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

Return line unit price including tax.

Parameters

SupplierProposal | CommandeFournisseur | Propal | Facture | Commande	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)

Returns

string

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

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

pdf_getlinevatrate()

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

Return line vat rate.

Parameters

SupplierProposal | CommandeFournisseur | FactureFournisseur | Propal | Facture | Commande | ExpenseReport | StockTransfer	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)

Returns

string

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

References $conf, $mysoc, $object, getDolGlobalString(), price2num(), and vatrate().

Referenced by pdf_standard_expensereport\printLine(), pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), and pdf_zenith\write_file().

pdf_getPDFFont()

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 273 of file pdf.lib.php.

References getDolGlobalString().

Referenced by pdf_standard_actions\_pagehead(), dolPrintSignatureImage(), pdf_pagefoot(), rebuild_merge_pdf(), BordereauChequeBlochet\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_standardlabel\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_tcpdflabel\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), and pdf_standard_salary\writeFile().

pdf_getPDFFontSize()

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 294 of file pdf.lib.php.

References getDolGlobalString().

Referenced by pdf_merou\_pagefoot(), pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_balance\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_bookkeeping\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_ledger\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_paiement\_pagehead(), pdf_rouget\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_evaluation\_pagehead(), pdf_standard_expensereport\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_salary\_pagehead(), pdf_standard_stock\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_timespent\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), pdf_zenith\_pagehead(), pdf_azur\_signature_area(), pdf_sepamandate\_signature_area(), pdf_aurore\_tableau(), pdf_azur\_tableau(), pdf_balance\_tableau(), pdf_baleine\_tableau(), pdf_ban\_tableau(), pdf_beluga\_tableau(), pdf_bookkeeping\_tableau(), pdf_canelle\_tableau(), pdf_cornas\_tableau(), pdf_cyan\_tableau(), pdf_eagle\_tableau(), pdf_eagle_proforma\_tableau(), pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_espadon\_tableau(), pdf_ledger\_tableau(), pdf_merou\_tableau(), pdf_muscadet\_tableau(), pdf_octopus\_tableau(), pdf_rouget\_tableau(), pdf_sepamandate\_tableau(), pdf_soleil\_tableau(), pdf_sponge\_tableau(), pdf_squille\_tableau(), pdf_standard\_tableau(), pdf_standard_asset\_tableau(), pdf_standard_expensereport\_tableau(), pdf_standard_movementstock\_tableau(), pdf_standard_myobject\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), pdf_standard_stock\_tableau(), pdf_standard_supplierpayment\_tableau(), pdf_storm\_tableau(), pdf_timespent\_tableau(), pdf_typhon\_tableau(), pdf_vinci\_tableau(), pdf_zenith\_tableau(), pdf_standard_supplierpayment\_tableau_cheque(), pdf_aurore\_tableau_info(), pdf_azur\_tableau_info(), pdf_cornas\_tableau_info(), pdf_einstein\_tableau_info(), pdf_muscadet\_tableau_info(), pdf_sepamandate\_tableau_info(), pdf_storm\_tableau_info(), pdf_typhon\_tableau_info(), pdf_vinci\_tableau_info(), pdf_zenith\_tableau_info(), pdf_aurore\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_eagle\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_squille\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), pdf_canelle\_tableau_versements(), BordereauChequeBlochet\Body(), pdf_paiement\Body(), pdf_standard_salary\body(), dolPrintSignatureImage(), pdf_cyan\drawInfoTable(), pdf_eagle_proforma\drawInfoTable(), pdf_eratosthene\drawInfoTable(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), pdf_octopus\drawPaymentsTable(), pdf_sponge\drawPaymentsTable(), pdf_cyan\drawSignatureArea(), pdf_cyan\drawTotalTable(), pdf_eagle_proforma\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), BordereauChequeBlochet\Header(), pdf_standard_salary\tableauHeader(), pdf_octopus\tableFirstPage(), pdf_standard_expensereport\tablePayments(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

pdf_getSizeForImage()

pdf_getSizeForImage

(

$realpath

)

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

Parameters

string

$realpath

Full path to photo file to use

Returns

array{width:int,height:int} Height and width to use to output image (in pdf user unit, so mm)

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

References dol_getImageSize(), and getDolGlobalInt().

Referenced by pdf_aurore\write_file(), pdf_azur\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_rouget\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_storm\write_file(), and pdf_zenith\write_file().

pdf_getSubstitutionArray()

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

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

Parameters

Translate	$outputlangs	Output language
null | string[]	$exclude	Array of family keys we want to exclude. For example array('mycompany', 'object', 'date', 'user', 'ticket', 'member', 'candidate'...)
?Object	$object	Object
	int<0,2>	$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)
null | string[]	$include	Array of family keys we want to include. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)

Returns

array<string,string> Array of substitutions

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

References $object.

Referenced by BordereauChequeBlochet\_pagefoot(), pdf_pagefoot(), pdf_watermark(), pdf_octopus\tableFirstPage(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

pdf_pagefoot()

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

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
float	$marge_basse	Margin bottom we use for the autobreak
float	$marge_gauche	Margin left (no more used)
float	$page_hauteur	Page height
?CommonObject	$object	Object shown in PDF
	int<0,3>	$showdetails Show company address details into footer (0=Nothing, 1=Show address, 2=Show managers, 3=Both)
	int<0,1>	$hidefreetext 1=Hide free text, 0=Show free text
float	$page_largeur	Page width
string	$watermark	Watermark text to print on page

Returns

int Return height of bottom margin including footer text

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

References $conf, $object, complete_substitutions_array(), dol_htmlentitiesbr(), getDolCurrency(), getDolGlobalInt(), getDolGlobalString(), getFormeJuridiqueLabel(), make_substitutions(), pdf_getPDFFont(), pdf_getSubstitutionArray(), pdf_watermark(), pdfGetHeightForHtmlContent(), price(), and price2num().

Referenced by BordereauChequeBlochet\_pagefoot(), pdf_aurore\_pagefoot(), pdf_azur\_pagefoot(), pdf_balance\_pagefoot(), pdf_baleine\_pagefoot(), pdf_beluga\_pagefoot(), pdf_bookkeeping\_pagefoot(), pdf_canelle\_pagefoot(), pdf_cornas\_pagefoot(), pdf_cyan\_pagefoot(), pdf_eagle\_pagefoot(), pdf_eagle_proforma\_pagefoot(), pdf_einstein\_pagefoot(), pdf_eratosthene\_pagefoot(), pdf_espadon\_pagefoot(), pdf_ledger\_pagefoot(), pdf_muscadet\_pagefoot(), pdf_octopus\_pagefoot(), pdf_rouget\_pagefoot(), pdf_sepamandate\_pagefoot(), pdf_soleil\_pagefoot(), pdf_sponge\_pagefoot(), pdf_squille\_pagefoot(), pdf_standard\_pagefoot(), pdf_standard_asset\_pagefoot(), pdf_standard_evaluation\_pagefoot(), pdf_standard_expensereport\_pagefoot(), pdf_standard_movementstock\_pagefoot(), pdf_standard_myobject\_pagefoot(), pdf_standard_recruitmentjobposition\_pagefoot(), pdf_standard_salary\_pagefoot(), pdf_standard_stock\_pagefoot(), pdf_standard_supplierpayment\_pagefoot(), pdf_storm\_pagefoot(), pdf_strato\_pagefoot(), pdf_timespent\_pagefoot(), pdf_typhon\_pagefoot(), pdf_vinci\_pagefoot(), and pdf_zenith\_pagefoot().

pdf_pagehead()

pdf_pagehead	(		$pdf,
			$outputlangs,
			$page_height )

Show header of page for PDF generation.

Parameters

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

Returns

void

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

References $conf, getDolGlobalFloat(), and getDolGlobalString().

Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_balance\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_bookkeeping\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_ledger\_pagehead(), pdf_merou\_pagehead(), pdf_octopus\_pagehead(), pdf_rouget\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_salary\_pagehead(), pdf_standard_stock\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_timespent\_pagehead(), and pdf_typhon\_pagehead().

pdf_render_subtotals()

pdf_render_subtotals	(	TCPDF	$pdf,
		CommonDocGenerator	$generator,
		float	$curY,
		CommonObject	$object,
		int	$i,
		Translate	$outputlangs,
		int	$hideref,
		int	$hidedesc,
		array	$bgColor,
		bool	$isSubtotal = false,
		bool	$applySubtotalLogic = true )

Render subtotals line with a colored background and adapted text color .

Parameters

TCPDF	$pdf	PDF instance
CommonDocGenerator	$generator	Generator object
float	$curY	Current Y position
CommonObject	$object	Object containing lines
int	$i	Current line number
Translate	$outputlangs	Output language object
int	$hideref	Hide reference
int	$hidedesc	Hide description
	array<int,int>	$bgColor RGB color array [R,G,B]
bool	$isSubtotal	Whether this is a subtotal line
bool	$applySubtotalLogic	Whether to apply subtotal specific logic

Returns

void

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

References $object, colorIsLight(), CommonDocGenerator\printColDescContent(), and CommonDocGenerator\setAfterColsLinePositionsData().

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

pdf_watermark()

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

Add a draft watermark on PDF files.

Parameters

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

Returns

void

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

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

Referenced by pdf_eagle_proforma\_pagehead(), pdf_merou\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_expensereport\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_stock\_pagehead(), pdf_storm\_pagehead(), pdf_typhon\_pagehead(), and pdf_pagefoot().

pdf_writelinedesc()

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

Output line description into PDF.

Parameters

TCPDF	$pdf	PDF object
CommonObject	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object lang for output
float	$w	Width
float	$h	Height
float	$posx	Pos x
float	$posy	Pos y
	int<0,1>	$hideref Hide reference
	int<0,1>	$hidedesc Hide description
	int<0,1>	$issupplierline Is it a line for a supplier object ?
	'L'|'C'|'R'|'J'	$align text alignment ('L', 'C', 'R', 'J' (default))

Returns

string

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

References $object, getDolGlobalString(), and pdf_getlinedesc().

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

pdf_writeLinkedObjects()

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

Show linked objects for PDF generation.

Parameters

TCPDF	$pdf	Object PDF
CommonObject	$object	Object
Translate	$outputlangs	Object lang
float	$posx	X
float	$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.
string	$align	Align
float	$default_font_size	Font size

Returns

float The Y PDF position

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

References $object.

Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_sponge\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_stock\_pagehead(), pdf_storm\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), and pdf_zenith\_pagehead().

pdfBuildThirdpartyName()

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

Returns the name of the thirdparty.

Parameters

Societe | Contact | null	$thirdparty	Contact or thirdparty
Translate	$outputlangs	Output language
	int<0,1>	$includealias 1=Include alias name after name

Returns

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

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

References getDolGlobalInt().

Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_rouget\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_typhon\_pagehead(), pdf_zenith\_pagehead(), and pdf_strato\tabSignature().

pdfCertifMention()

pdfCertifMention	(		$pdf,
			$outputlangs,
			$seller,
			$default_font_size,
		&	$posy,
			$pdftemplate )

Add legal certificate mention.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang
Societe	$seller	Seller company
int	$default_font_size	Default font size
float	$posy	Y position
CommonDocGenerator	$pdftemplate	PDF template

Returns

int 0 if nothing done, 1 if a mention was printed

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

References pdfCertifMentionblockedLog().

Referenced by pdf_octopus\drawInfoTable(), and pdf_sponge\drawInfoTable().

pdfExtractMetadata()

pdfExtractMetadata	(		$file,
			$field = 'Keywords' )

Function to extract metadata from a PDF file by doing a binary parsing of the PDF file.

Parameters

string	$file	Path of file
string	$field	Key to extract

Returns

string String of the extracted key or string started with 'ERROR:' if error.

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

References dol_is_file(), and dol_osencode().

pdfGetHeightForHtmlContent()

pdfGetHeightForHtmlContent	(		$pdf,
			$htmlcontent )

Function to try to calculate height of a HTML Content.

WARNING: Do not use this function inside a TCPDF transaction.

Parameters

TCPDF	$pdf	PDF initialized object
string	$htmlcontent	HTML Content

Returns

float Height

See also

getStringHeight()

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

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

pdfGetLineTotalDiscountAmount()

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

Return line total amount discount.

Calculated by taking the unit price (subprice) * quantity - (total without tax)

Parameters

Commande | Facture | Propal	$object	Object
int	$i	Current line number
Translate	$outputlangs	Object langs for output
	int<0,2>	$hidedetails Hide details (0=no, 1=yes, 2=just special lines)
	int<0,1>	$multicurrency 1=Get value in the foreign currency

Returns

int|float|string Return total of line excl tax

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

References $object, getDolGlobalString(), and price2num().

Referenced by pdf_azur\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_cyan\drawTotalTable(), pdf_eratosthene\drawTotalTable(), and pdf_sponge\drawTotalTable().

pdfWriteAdditionnalTitle()

pdfWriteAdditionnalTitle	(		$pdf,
			$outputlangs,
			$page_height,
			$object,
		&	$w,
		&	$posx,
		&	$posy )

Add some information from the blockedlog module.

Parameters

TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang for output
float	$page_height	Height of page
Facture	$object	Object invoice
int	$w	Width for text
float	$posx	Pos x
float	$posy	Pos y

Returns

void

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

References $object, and pdfWriteBlockedLogSignature().

Referenced by pdf_octopus\_pagehead(), and pdf_sponge\_pagehead().

pdfWriteAlreadyPaid()

pdfWriteAlreadyPaid	(		$docgenerator,
		&	$index,
			$pdf,
			$outputlangs,
			$outputlangsbis,
			$object,
			$col1x,
			$col2x,
			$largcol2,
			$tab2_top,
			$tab2_hl,
			$deja_regle,
			$creditnoteamount,
			$depositsamount,
			$resteapayer,
			$resteapayer_origin )

Add some information from the blockedlog module.

Parameters

CommonDocGenerator	$docgenerator	Doc generator
int	$index	Index
TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang for output
?Translate	$outputlangsbis	Object lang for output
Facture	$object	Object invoice
float	$col1x	Col1x
float	$col2x	Col2x
float	$largcol2	Largcol2
float	$tab2_top	Tab2_top
float	$tab2_hl	Tab2_hl
float	$deja_regle	Already paid
float	$creditnoteamount	Credit notes amount
float	$depositsamount	Deposits amount
float	$resteapayer	Remain to pay
float	$resteapayer_origin	Remain to pay

Returns

void

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

References $mysoc, $object, getDolGlobalInt(), getDolGlobalString(), isALNERunningVersion(), isModEnabled(), price(), and price2num().

Referenced by pdf_octopus\drawTotalTable(), and pdf_sponge\drawTotalTable().

pdfWriteVATArray()

pdfWriteVATArray	(		$docgenerator,
		&	$index,
			$pdf,
			$outputlangs,
			$outputlangsbis,
			$object,
			$col1x,
			$col2x,
			$largcol2,
			$tab2_top,
			$tab2_hl )

Add some information from the blockedlog module.

Parameters

CommonDocGenerator	$docgenerator	Doc generator
int	$index	Index
TCPDF	$pdf	Object PDF
Translate	$outputlangs	Object lang for output
?Translate	$outputlangsbis	Object lang for output
Facture	$object	Object invoice
float	$col1x	Col1x
float	$col2x	Col2x
float	$largcol2	Largcol2
float	$tab2_top	Tab2_top
float	$tab2_hl	Tab2_hl

Returns

void

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

References $mysoc, $object, getDolGlobalInt(), getDolGlobalString(), isModEnabled(), price(), price2num(), and vatrate().

Referenced by pdf_octopus\drawTotalTable(), and pdf_sponge\drawTotalTable().