Merge pull request #5616 from marcosgdf/phpdoc
Little changes to PHPDoc comment block
This commit is contained in:
commit
42e573c7fb
@ -119,12 +119,14 @@ function dolGetModulesDirs($subdir='')
|
|||||||
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
|
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
|
||||||
* @return string Default paper format code
|
* @return string Default paper format code
|
||||||
*/
|
*/
|
||||||
function dol_getDefaultFormat($outputlangs='')
|
function dol_getDefaultFormat(Translate $outputlangs = null)
|
||||||
{
|
{
|
||||||
global $langs;
|
global $langs;
|
||||||
|
|
||||||
$selected='EUA4';
|
$selected='EUA4';
|
||||||
if (empty($outputlangs) || ! is_object($outputlangs)) $outputlangs=$langs;
|
if (!$outputlangs) {
|
||||||
|
$outputlangs=$langs;
|
||||||
|
}
|
||||||
|
|
||||||
if ($outputlangs->defaultlang == 'ca_CA') $selected='CAP4'; // Canada
|
if ($outputlangs->defaultlang == 'ca_CA') $selected='CAP4'; // Canada
|
||||||
if ($outputlangs->defaultlang == 'en_US') $selected='USLetter'; // US
|
if ($outputlangs->defaultlang == 'en_US') $selected='USLetter'; // US
|
||||||
@ -1617,7 +1619,7 @@ function dol_buildlogin($lastname,$firstname)
|
|||||||
/**
|
/**
|
||||||
* Return array to use for SoapClient constructor
|
* Return array to use for SoapClient constructor
|
||||||
*
|
*
|
||||||
* @return param
|
* @return array
|
||||||
*/
|
*/
|
||||||
function getSoapParams()
|
function getSoapParams()
|
||||||
{
|
{
|
||||||
|
|||||||
@ -39,7 +39,7 @@
|
|||||||
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
|
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
|
||||||
* @return array Array('width'=>w,'height'=>h,'unit'=>u);
|
* @return array Array('width'=>w,'height'=>h,'unit'=>u);
|
||||||
*/
|
*/
|
||||||
function pdf_getFormat($outputlangs='')
|
function pdf_getFormat(Translate $outputlangs = null)
|
||||||
{
|
{
|
||||||
global $conf,$db;
|
global $conf,$db;
|
||||||
|
|
||||||
@ -77,7 +77,7 @@ function pdf_getFormat($outputlangs='')
|
|||||||
* @param string $format Array(width,height). Keep empty to use default setup.
|
* @param string $format Array(width,height). Keep empty to use default setup.
|
||||||
* @param string $metric Unit of format ('mm')
|
* @param string $metric Unit of format ('mm')
|
||||||
* @param string $pagetype 'P' or 'l'
|
* @param string $pagetype 'P' or 'l'
|
||||||
* @return TPDF PDF object
|
* @return TCPDF PDF object
|
||||||
*/
|
*/
|
||||||
function pdf_getInstance($format='',$metric='mm',$pagetype='P')
|
function pdf_getInstance($format='',$metric='mm',$pagetype='P')
|
||||||
{
|
{
|
||||||
@ -568,7 +568,7 @@ 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 TCPDF $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
|
* @return void
|
||||||
@ -589,7 +589,7 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
|
|||||||
/**
|
/**
|
||||||
* Add a draft watermark on PDF files
|
* Add a draft watermark on PDF files
|
||||||
*
|
*
|
||||||
* @param PDF $pdf Object PDF
|
* @param TCPDF $pdf Object PDF
|
||||||
* @param Translate $outputlangs Object lang
|
* @param Translate $outputlangs Object lang
|
||||||
* @param int $h Height of PDF
|
* @param int $h Height of PDF
|
||||||
* @param int $w Width of PDF
|
* @param int $w Width of PDF
|
||||||
@ -629,7 +629,7 @@ function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text)
|
|||||||
/**
|
/**
|
||||||
* Show bank informations for PDF generation
|
* Show bank informations for PDF generation
|
||||||
*
|
*
|
||||||
* @param PDF $pdf Object PDF
|
* @param TCPDF $pdf Object PDF
|
||||||
* @param Translate $outputlangs Object lang
|
* @param Translate $outputlangs Object lang
|
||||||
* @param int $curx X
|
* @param int $curx X
|
||||||
* @param int $cury Y
|
* @param int $cury Y
|
||||||
@ -805,7 +805,7 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0,$default
|
|||||||
/**
|
/**
|
||||||
* Show footer of page for PDF generation
|
* Show footer of page for PDF generation
|
||||||
*
|
*
|
||||||
* @param PDF $pdf The PDF factory
|
* @param TCPDF $pdf The PDF factory
|
||||||
* @param Translate $outputlangs Object lang for output
|
* @param Translate $outputlangs Object lang for output
|
||||||
* @param string $paramfreetext Constant name of free text
|
* @param string $paramfreetext Constant name of free text
|
||||||
* @param Societe $fromcompany Object company
|
* @param Societe $fromcompany Object company
|
||||||
@ -1037,7 +1037,7 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
|
|||||||
/**
|
/**
|
||||||
* Show linked objects for PDF generation
|
* Show linked objects for PDF generation
|
||||||
*
|
*
|
||||||
* @param PDF $pdf Object PDF
|
* @param TCPDF $pdf Object PDF
|
||||||
* @param object $object Object
|
* @param object $object Object
|
||||||
* @param Translate $outputlangs Object lang
|
* @param Translate $outputlangs Object lang
|
||||||
* @param int $posx X
|
* @param int $posx X
|
||||||
@ -1074,7 +1074,7 @@ function pdf_writeLinkedObjects(&$pdf,$object,$outputlangs,$posx,$posy,$w,$h,$al
|
|||||||
/**
|
/**
|
||||||
* Output line description into PDF
|
* Output line description into PDF
|
||||||
*
|
*
|
||||||
* @param PDF $pdf PDF object
|
* @param TCPDF $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
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user