This commit is contained in:
Laurent Destailleur 2011-12-06 00:39:24 +01:00
parent 0f6b1418b1
commit 28afd2e3c6

View File

@ -1,5 +1,5 @@
<?php <?php
/* Copyright (C) 2006-2010 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2006-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2006 Rodolphe Quiedeville <rodolphe@quiedeville.org> * Copyright (C) 2006 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com> * Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com>
* Copyright (C) 2010-2011 Regis Houssin <regis@dolibarr.fr> * Copyright (C) 2010-2011 Regis Houssin <regis@dolibarr.fr>
@ -67,10 +67,10 @@ function pdf_getFormat()
/** /**
* Return a PDF instance object. We create a FPDI instance that instanciate TCPDF. * Return a PDF instance object. We create a FPDI instance that instanciate TCPDF.
* *
* @param format Array(width,height). Keep empty to use default setup. * @param string $format Array(width,height). Keep empty to use default setup.
* @param metric Unit of format ('mm') * @param string $metric Unit of format ('mm')
* @param pagetype 'P' or 'l' * @param string $pagetype 'P' or 'l'
* @return PDF object * @return TPDF PDF object
*/ */
function pdf_getInstance($format='',$metric='mm',$pagetype='P') function pdf_getInstance($format='',$metric='mm',$pagetype='P')
{ {
@ -127,8 +127,8 @@ function pdf_getInstance($format='',$metric='mm',$pagetype='P')
/** /**
* Return font name to use for PDF generation * Return font name to use for PDF generation
* *
* @param outputlangs Output langs object * @param Translate $outputlangs Output langs object
* @return string Name of font to use * @return string Name of font to use
*/ */
function pdf_getPDFFont($outputlangs) function pdf_getPDFFont($outputlangs)
{ {
@ -146,8 +146,8 @@ function pdf_getPDFFont($outputlangs)
/** /**
* Return font size to use for PDF generation * Return font size to use for PDF generation
* *
* @param outputlangs Output langs object * @param Translate $outputlangs Output langs object
* @return int Size of font to use * @return int Size of font to use
*/ */
function pdf_getPDFFontSize($outputlangs) function pdf_getPDFFontSize($outputlangs)
{ {
@ -166,14 +166,14 @@ function pdf_getPDFFontSize($outputlangs)
/** /**
* Return a string with full address formated * Return a string with full address formated
* *
* @param outputlangs Output langs object * @param Translate $outputlangs Output langs object
* @param sourcecompany Source company object * @param Societe $sourcecompany Source company object
* @param targetcompany Target company object * @param Societe $targetcompany Target company object
* @param targetcontact Target contact object * @param Contact $targetcontact Target contact object
* @param usecontact Use contact instead of company * @param int $usecontact Use contact instead of company
* @param mode Address type * @param int $mode Address type
* @param deliverycompany Delivery company object * @param Societe $deliverycompany Delivery company object
* @return string String with full address * @return string String with full address
*/ */
function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$targetcontact='',$usecontact=0,$mode='source',$deliverycompany='') function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$targetcontact='',$usecontact=0,$mode='source',$deliverycompany='')
{ {
@ -265,9 +265,10 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target
/** /**
* Show header of page for PDF generation * Show header of page for PDF generation
* *
* @param PDF $pdf Object PDF * @param PDF &$pdf Object PDF
* @param Translate $outputlangs Object lang for output * @param Translate $outputlangs Object lang for output
* @param int $page_height Height of page * @param int $page_height Height of page
* @return void
*/ */
function pdf_pagehead(&$pdf,$outputlangs,$page_height) function pdf_pagehead(&$pdf,$outputlangs,$page_height)
{ {
@ -284,12 +285,13 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
/** /**
* Add a draft watermark on PDF files * Add a draft watermark on PDF files
* *
* @param pdf Object PDF * @param PDF &$pdf Object PDF
* @param outputlangs Object lang * @param Translate $outputlangs Object lang
* @param h Height of PDF * @param int $h Height of PDF
* @param w Width of PDF * @param int $w Width of PDF
* @param unit Unit of height (mmn, pt, ...) * @param string $unit Unit of height (mmn, pt, ...)
* @param text Text to show * @param string $text Text to show
* @return void
*/ */
function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text) function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text)
{ {
@ -324,6 +326,7 @@ function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text)
* @param cury Y * @param cury Y
* @param account Bank account object * @param account Bank account object
* @param onlynumber Output only number * @param onlynumber Output only number
* @return void
*/ */
function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0) function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
{ {
@ -462,18 +465,18 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
/** /**
* Show footer of page for PDF generation * Show footer of page for PDF generation
* *
* @param pdf The PDF factory * @param PDF &$pdf The PDF factory
* @param outputlangs Object lang for output * @param Translate $outputlangs Object lang for output
* @param paramfreetext Constant name of free text * @param string $paramfreetext Constant name of free text
* @param fromcompany Object company * @param Societe $fromcompany Object company
* @param marge_basse Margin bottom * @param int $marge_basse Margin bottom
* @param marge_gauche Margin left * @param int $marge_gauche Margin left
* @param page_hauteur Page height * @param int $page_hauteur Page height
* @param object Object shown in PDF * @param Object $object Object shown in PDF
* @param showdetails Show company details * @param int $showdetails Show company details
* @return void * @return void
*/ */
function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_basse,$marge_gauche,$page_hauteur,$object,$showdetails=0) function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_basse,$marge_gauche,$page_hauteur,$object,$showdetails=0)
{ {
@ -662,19 +665,19 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
/** /**
* Output line description into PDF * Output line description into PDF
* *
* @param PDF $pdf PDF object * @param PDF $pdf PDF object
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object lang for output * @param Translate $outputlangs Object lang for output
* @param int $w Width * @param int $w Width
* @param int $h Height * @param int $h Height
* @param int $posx Pos x * @param int $posx Pos x
* @param int $posy Pos y * @param int $posy Pos y
* @param int $hideref Hide reference * @param int $hideref Hide reference
* @param int $hidedesc Hide description * @param int $hidedesc Hide description
* @param int $issupplierline Is it a line for a supplier object ? * @param int $issupplierline Is it a line for a supplier object ?
* @param HookManager $hookmanager Instance of HookManager * @param HookManager $hookmanager Instance of HookManager
* @return void * @return void
*/ */
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false) function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
{ {
@ -702,13 +705,13 @@ function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hide
/** /**
* Return line description translated in outputlangs and encoded in UTF8 * Return line description translated in outputlangs and encoded in UTF8
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hideref Hide reference * @param int $hideref Hide reference
* @param int $hidedesc Hide description * @param int $hidedesc Hide description
* @param int $issupplierline Is it a line for a supplier object ? * @param int $issupplierline Is it a line for a supplier object ?
* @return string String with line * @return string String with line
*/ */
function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issupplierline=0) function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issupplierline=0)
{ {
@ -843,12 +846,12 @@ function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issuppl
/** /**
* Return line num * Return line num
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -868,12 +871,12 @@ function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
/** /**
* Return line product ref * Return line product ref
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -892,12 +895,12 @@ function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
/** /**
* Return line ref_supplier * Return line ref_supplier
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -916,12 +919,12 @@ function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0,$hookman
/** /**
* Return line vat rate * Return line vat rate
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlinevatrate($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlinevatrate($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -942,12 +945,12 @@ function pdf_getlinevatrate($object,$i,$outputlangs,$hidedetails=0,$hookmanager=
/** /**
* Return line unit price excluding tax * Return line unit price excluding tax
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineupexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineupexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -972,13 +975,12 @@ function pdf_getlineupexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanage
/** /**
* Return line unit price including tax * Return line unit price including tax
* @param object Object *
* @param i Current line number * @param Object $object Object
* @param outputlangs Object langs for output * @param int $i Current line number
* @param hidedetails Hide value * @param Tranlate $outputlangs Object langs for output
* 0 = no * @param int $hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)
* 1 = yes * @return void
* 2 = just special lines
*/ */
function pdf_getlineupwithtax($object,$i,$outputlangs,$hidedetails=0) function pdf_getlineupwithtax($object,$i,$outputlangs,$hidedetails=0)
{ {
@ -1000,11 +1002,12 @@ function pdf_getlineupwithtax($object,$i,$outputlangs,$hidedetails=0)
/** /**
* Return line quantity * Return line quantity
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void
*/ */
function pdf_getlineqty($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineqty($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1028,12 +1031,12 @@ function pdf_getlineqty($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
/** /**
* Return line quantity asked * Return line quantity asked
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineqty_asked($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineqty_asked($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1057,12 +1060,12 @@ function pdf_getlineqty_asked($object,$i,$outputlangs,$hidedetails=0,$hookmanage
/** /**
* Return line quantity shipped * Return line quantity shipped
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineqty_shipped($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineqty_shipped($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1086,12 +1089,12 @@ function pdf_getlineqty_shipped($object,$i,$outputlangs,$hidedetails=0,$hookmana
/** /**
* Return line keep to ship quantity * Return line keep to ship quantity
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineqty_keeptoship($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineqty_keeptoship($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1115,12 +1118,12 @@ function pdf_getlineqty_keeptoship($object,$i,$outputlangs,$hidedetails=0,$hookm
/** /**
* Return line remise percent * Return line remise percent
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlineremisepercent($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlineremisepercent($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1146,12 +1149,12 @@ function pdf_getlineremisepercent($object,$i,$outputlangs,$hidedetails=0,$hookma
/** /**
* Return line total excluding tax * Return line total excluding tax
* *
* @param Object $object Object * @param Object $object Object
* @param int $i Current line number * @param int $i Current line number
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines) * @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getlinetotalexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false) function pdf_getlinetotalexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
{ {
@ -1183,13 +1186,12 @@ function pdf_getlinetotalexcltax($object,$i,$outputlangs,$hidedetails=0,$hookman
/** /**
* Return line total including tax * Return line total including tax
* @param object Object *
* @param i Current line number * @param Object $object Object
* @param outputlangs Object langs for output * @param int $i Current line number
* @param hidedetails Hide value * @param Translate $outputlangs Object langs for output
* 0 = no * @param int $hidedetails Hide value (0 = no, 1 = yes, 2 = just special lines)
* 1 = yes * @return void
* 2 = just special lines
*/ */
function pdf_getlinetotalwithtax($object,$i,$outputlangs,$hidedetails=0) function pdf_getlinetotalwithtax($object,$i,$outputlangs,$hidedetails=0)
{ {
@ -1219,11 +1221,11 @@ function pdf_getlinetotalwithtax($object,$i,$outputlangs,$hidedetails=0)
/** /**
* Return total quantity of products and/or services * Return total quantity of products and/or services
* *
* @param Object $object Object * @param Object $object Object
* @param string $type Type * @param string $type Type
* @param Translate $outputlangs Object langs for output * @param Translate $outputlangs Object langs for output
* @param HookManager $hookmanager Hook manager instance * @param HookManager $hookmanager Hook manager instance
* @return void * @return void
*/ */
function pdf_getTotalQty($object,$type='',$outputlangs,$hookmanager=false) function pdf_getTotalQty($object,$type='',$outputlangs,$hookmanager=false)
{ {
@ -1286,5 +1288,4 @@ function pdf_getCurrencySymbol(&$pdf, $currency_code)
return $currency_sign; return $currency_sign;
} }
?> ?>