dolibarr 21.0.0-alpha
|
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. | |
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. | |
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. | |
pdf_getLinkedObjects (&$object, $outputlangs) | |
Return linked objects to use for document generation. | |
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) | |
Return line total amount discount. | |
Set of functions used for PDF generation.
Definition in file pdf.lib.php.
pdf_admin_prepare_head | ( | ) |
Return array head with list of tabs to view object information.
Definition at line 48 of file pdf.lib.php.
References complete_head_from_modules().
pdf_bank | ( | & | $pdf, |
$outputlangs, | |||
$curx, | |||
$cury, | |||
$account, | |||
$onlynumber = 0, | |||
$default_font_size = 10 ) |
Show bank information for PDF generation.
TCPDF | 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 address) |
int | $default_font_size | Default font size |
Definition at line 845 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_crabe\_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 | ( | $outputlangs, | |
$sourcecompany, | |||
$targetcompany = '', | |||
$targetcontact = '', | |||
$usecontact = 0, | |||
$mode = 'source', | |||
$object = null ) |
Return a string with full address formatted for output on PDF documents.
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 |
Definition at line 434 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_crabe\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle\_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_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), and pdf_zenith\_pagehead().
pdf_getEncryption | ( | $pathoffile | ) |
Return if pdf file is protected/encrypted.
string | $pathoffile | Path of file |
Definition at line 234 of file pdf.lib.php.
pdf_getFormat | ( | $outputlangs = null, | |
$mode = 'setup' ) |
Return array with format properties of default PDF format.
?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 |
Definition at line 86 of file pdf.lib.php.
References dol_getDefaultFormat(), dol_syslog(), and getDolGlobalString().
Referenced by BordereauChequeBlochet\__construct(), pdf_aurore\__construct(), pdf_azur\__construct(), pdf_baleine\__construct(), pdf_ban\__construct(), pdf_beluga\__construct(), pdf_canelle\__construct(), pdf_cornas\__construct(), pdf_crabe\__construct(), pdf_cyan\__construct(), pdf_eagle\__construct(), pdf_eagle_proforma\__construct(), pdf_einstein\__construct(), pdf_eratosthene\__construct(), pdf_espadon\__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_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 | ( | $logo, | |
$url = false ) |
Return height to use for Logo onto PDF.
string | $logo | Full path to logo file to use |
bool | $url | Image with url (true or false) |
Definition at line 313 of file pdf.lib.php.
References dol_getImageSize(), and getDolGlobalString().
Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_cornas\_pagehead(), pdf_crabe\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle\_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_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 | ( | $format = '', | |
$metric = 'mm', | |||
$pagetype = 'P' ) |
Return a PDF instance object.
We create a FPDI instance that instantiate TCPDF.
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' |
Definition at line 128 of file pdf.lib.php.
References dol_mkdir(), getDolGlobalInt(), and getDolGlobalString().
Referenced by rebuild_merge_pdf(), BordereauChequeBlochet\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_crabe\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_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(), and pdf_zenith\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
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 ? |
Definition at line 1490 of file pdf.lib.php.
References $object, dol_concatdesc(), dol_html_entity_decode(), dol_htmlentitiesbr(), dol_print_date(), dol_textishtml(), getDolGlobalInt(), and getDolGlobalString().
Referenced by pdf_writelinedesc().
pdf_getlinenum | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line num.
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) |
Definition at line 1833 of file pdf.lib.php.
References $object, and dol_htmlentitiesbr().
pdf_getlineprogress | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0, | |||
$hookmanager = null ) |
Return line percent.
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 |
Definition at line 2324 of file pdf.lib.php.
References $object, and getDolGlobalString().
Referenced by pdf_crabe\write_file(), pdf_octopus\write_file(), and pdf_sponge\write_file().
pdf_getlineqty | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line quantity.
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) |
Definition at line 2078 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_crabe\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 | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line quantity asked.
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) |
Definition at line 2118 of file pdf.lib.php.
References $object.
pdf_getlineqty_keeptoship | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line keep to ship quantity.
Object | $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) |
Definition at line 2198 of file pdf.lib.php.
References $object.
pdf_getlineqty_shipped | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line quantity shipped.
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) |
Definition at line 2158 of file pdf.lib.php.
References $object.
pdf_getlineref | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line product ref.
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) |
Definition at line 1866 of file pdf.lib.php.
References $object, and dol_htmlentitiesbr().
pdf_getlineref_supplier | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line ref_supplier.
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) |
Definition at line 1899 of file pdf.lib.php.
References $object, and dol_htmlentitiesbr().
pdf_getlineremisepercent | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line remise percent.
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) |
Definition at line 2281 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_crabe\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 | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line total excluding tax.
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) |
Definition at line 2375 of file pdf.lib.php.
References $object, getDolGlobalString(), and price().
Referenced by pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_crabe\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 | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line total including tax.
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) |
Definition at line 2431 of file pdf.lib.php.
References $object, getDolGlobalString(), and price().
Referenced by pdf_cyan\write_file(), pdf_eratosthene\write_file(), and pdf_sponge\write_file().
pdf_getlineunit | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line unit.
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) |
Definition at line 2238 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_crabe\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 | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line unit price excluding tax.
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) |
Definition at line 1993 of file pdf.lib.php.
References $object, getDolGlobalString(), 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_crabe\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 | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line unit price including tax.
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) |
Definition at line 2036 of file pdf.lib.php.
References $object, getDolGlobalString(), and price().
pdf_getlinevatrate | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line vat rate.
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) |
Definition at line 1931 of file pdf.lib.php.
References $object, getDolGlobalString(), and vatrate().
Referenced by pdf_standard_expensereport\printLine(), pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_crabe\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_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
CommonObject | $object | Object |
Translate | $outputlangs | Object lang for output |
Definition at line 2486 of file pdf.lib.php.
References $object, dol_concatdesc(), and dol_print_date().
Referenced by pdf_writeLinkedObjects().
pdf_getPDFFont | ( | $outputlangs | ) |
Return font name to use for PDF generation.
Translate | $outputlangs | Output langs object |
Definition at line 265 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_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_crabe\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_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(), and pdf_zenith\write_file().
pdf_getPDFFontSize | ( | $outputlangs | ) |
Return font size to use for PDF generation.
Translate | $outputlangs | Output langs object |
Definition at line 288 of file pdf.lib.php.
References getDolGlobalString().
Referenced by pdf_merou\_pagefoot(), pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_crabe\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_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_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_baleine\_tableau(), pdf_ban\_tableau(), pdf_beluga\_tableau(), pdf_canelle\_tableau(), pdf_cornas\_tableau(), pdf_crabe\_tableau(), pdf_cyan\_tableau(), pdf_eagle\_tableau(), pdf_eagle_proforma\_tableau(), pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_espadon\_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_crabe\_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_crabe\_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(), pdf_crabe\_tableau_versements(), pdf_octopus\_tableFirstPage(), BordereauChequeBlochet\Body(), pdf_paiement\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_expensereport\tablePayments(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_crabe\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_merou\write_file(), pdf_muscadet\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 | ( | $realpath | ) |
Return dimensions to use for images onto PDF checking that width and height are not higher than maximum (20x32 by default).
string | $realpath | Full path to photo file to use |
Definition at line 2625 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_crabe\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 | ( | $outputlangs, | |
$exclude = null, | |||
$object = null, | |||
$onlykey = 0, | |||
$include = null ) |
Return array of possible substitutions for PDF content (without external module substitutions).
Translate | $outputlangs | Output language |
null | string[] | $exclude | Array of family keys we want to exclude. For example array('mycompany', 'object', 'date', 'user', ...) |
?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', ...) |
Definition at line 767 of file pdf.lib.php.
References $object, and getCommonSubstitutionArray().
Referenced by BordereauChequeBlochet\_pagefoot(), pdf_pagefoot(), pdf_watermark(), 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_crabe\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_octopus\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_timespent\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().
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.
TCPDF | 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 |
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 | $hidefreetext | 1=Hide free text, 0=Show free text |
int | $page_largeur | Page width |
string | $watermark | Watermark text to print on page |
Definition at line 1022 of file pdf.lib.php.
References $object, complete_substitutions_array(), dol_htmlentitiesbr(), 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_baleine\_pagefoot(), pdf_beluga\_pagefoot(), pdf_canelle\_pagefoot(), pdf_cornas\_pagefoot(), pdf_crabe\_pagefoot(), pdf_cyan\_pagefoot(), pdf_eagle\_pagefoot(), pdf_eagle_proforma\_pagefoot(), pdf_einstein\_pagefoot(), pdf_eratosthene\_pagefoot(), pdf_espadon\_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_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, |
$outputlangs, | |||
$page_height ) |
Show header of page for PDF generation.
TCPDF | Object PDF | |
Translate | $outputlangs | Object lang for output |
int | $page_height | Height of page |
Definition at line 731 of file pdf.lib.php.
References getDolGlobalString().
Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_crabe\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_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_stock\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_timespent\_pagehead(), and pdf_typhon\_pagehead().
pdf_watermark | ( | & | $pdf, |
$outputlangs, | |||
$h, | |||
$w, | |||
$unit, | |||
$text ) |
Add a draft watermark on PDF files.
TCPDF | 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 |
Definition at line 787 of file pdf.lib.php.
References complete_substitutions_array(), dol_print_error(), make_substitutions(), and pdf_getSubstitutionArray().
Referenced by pdf_eagle\_pagehead(), 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, |
$object, | |||
$i, | |||
$outputlangs, | |||
$w, | |||
$h, | |||
$posx, | |||
$posy, | |||
$hideref = 0, | |||
$hidedesc = 0, | |||
$issupplierline = 0, | |||
$align = 'J' ) |
Output line description into PDF.
TCPDF | PDF object | |
CommonObject | $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<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)) |
Definition at line 1435 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_crabe\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, |
$object, | |||
$outputlangs, | |||
$posx, | |||
$posy, | |||
$w, | |||
$h, | |||
$align, | |||
$default_font_size ) |
Show linked objects for PDF generation.
TCPDF | Object PDF | |
CommonObject | $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. |
string | $align | Align |
float | $default_font_size | Font size |
Definition at line 1398 of file pdf.lib.php.
References $object, and pdf_getLinkedObjects().
Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_crabe\_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 | ( | $thirdparty, | |
Translate | $outputlangs, | ||
$includealias = 0 ) |
Returns the name of the thirdparty.
Societe | Contact | $thirdparty | Contact or thirdparty |
Translate | $outputlangs | Output language |
int<0,1> | $includealias 1=Include alias name after name |
Definition at line 386 of file pdf.lib.php.
References getDolGlobalInt().
Referenced by pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_crabe\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle\_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(), and pdf_zenith\_pagehead().
pdfGetHeightForHtmlContent | ( | & | $pdf, |
$htmlcontent ) |
Function to try to calculate height of a HTML Content.
TCPDF | PDF initialized object | |
string | $htmlcontent | HTML Content |
Definition at line 338 of file pdf.lib.php.
Referenced by pdf_pagefoot(), pdf_azur\write_file(), and pdf_cyan\write_file().
pdfGetLineTotalDiscountAmount | ( | $object, | |
$i, | |||
$outputlangs, | |||
$hidedetails = 0 ) |
Return line total amount discount.
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) |
Definition at line 2656 of file pdf.lib.php.
References $object, and getDolGlobalString().
Referenced by pdf_sponge\drawTotalTable().