Class to generate expense report based on standard model. More...

Inheritance diagram for pdf_standard:

Collaboration diagram for pdf_standard:

Public Member Functions
	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build pdf onto disk.

	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build pdf onto disk.

	__construct ($db)
	Constructor.

	addSticker (&$pdf, $outputlangs, $param)
	Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

	Add_PDF_card (&$pdf, $textleft, $header, $footer, $outputlangs, $textright='', $idmember=0, $photo='')
	Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

	write_file ($object, $outputlangs, $srctemplatepath, $mode='member', $nooutput=0, $filename='tmp_cards')
	Function to build PDF on disk, then output on HTTP stream.

	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build a document on disk using the generic odt module.

	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build a document on disk using the generic odt module.

	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build a document on disk using the generic odt module.

	__construct ($db)
	Constructor.

	write_file ($object, $outputlangs=null, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build pdf onto disk.

Public Member Functions inherited from CommonDocGenerator
	get_substitutionarray_user ($user, $outputlangs)
	Define array with couple substitution key => substitution value.

	getSubstitutionarrayMember ($member, $outputlangs)
	Define array with couple substitution key => substitution value.

	get_substitutionarray_mysoc ($mysoc, $outputlangs)
	Define array with couple substitution key => substitution value.

	get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company')
	Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}.

	get_substitutionarray_contact ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value.

	get_substitutionarray_other ($outputlangs)
	Define array with couple substitution key => substitution value.

	get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.

	get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
	Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.

	get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
	Define array with couple substitution key => substitution value.

	fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
	Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted.

	printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
	Rect pdf.

	columnSort ($a, $b)
	uasort callback function to Sort columns fields

	prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Prepare Array Column Field.

	getColumnContentWidth ($colKey)
	get column content width from column key

	getColumnContentXStart ($colKey)
	get column content X (abscissa) left position from column key

	getColumnRank ($colKey)
	get column position rank from column key

	insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false)
	get column position rank from column key

	printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
	print standard column content

	printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0)
	print description column content

	getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null)
	get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block

	getColumnStatus ($colKey)
	get column status from column key

	pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0)
	Print standard column content.

	defineColumnExtrafield ($object, $outputlangs, $hidedetails=0)
	Define Array Column Field for extrafields.

	defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Define Array Column Field into $this->cols This method must be implemented by the module that generate the document with its own columns.

Public Member Functions inherited from CommonStickerGenerator
	write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='')
	Function to build PDF on disk, then output on HTTP stream.

	Set_Char_Size (&$pdf, $pt)
	Methode qui permet de modifier la taille des caracteres Cela modiera aussi l'espace entre chaque ligne.

Protected Member Functions
	printLine (&$pdf, $object, $linenumber, $curY, $default_font_size, $outputlangs, $hidedetails=0)

	_pagehead (&$pdf, $object, $showaddress, $outputlangs)
	Show top header of page.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	tablePayments (&$pdf, $object, $posy, $outputlangs)
	Show payments table.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

	printLine (&$pdf, $object, $linenumber, $curY, $default_font_size, $outputlangs, $hidedetails=0)

	_pagehead (&$pdf, $object, $showaddress, $outputlangs)
	Show top header of page.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
	Show top header of page.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
	Show top header of page.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	_pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
	Show top header of page.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

	_tableau_cheque (&$pdf, $object, $posy, $outputlangs)
	Show total to pay.

	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
	Show table for lines.

	_pagehead (&$pdf, $object, $showaddress, $outputlangs)
	Show top header of page.

	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

Protected Member Functions inherited from CommonStickerGenerator
	_Pointille (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $nbPointilles=15)
	protected Print dot line

	_Croix (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $taille=4)
	protected Function realisant une croix aux 4 coins des cartes

	_Get_Height_Chars ($pt)
	protected Give the height for a char size given.

	_Set_Format (&$pdf, $format)
	protected Set format

Additional Inherited Members
Static Public Member Functions inherited from ModeleExpenseReport
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active models generation.

Static Public Member Functions inherited from ModelePDFEvaluation
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation modules.

Static Public Member Functions inherited from ModelePDFMovement
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation modules.

Static Public Member Functions inherited from ModelePDFProduct
static	liste_modeles ($dbs, $maxfilenamelength=0)
	Return list of active generation modules.

Static Public Member Functions inherited from ModelePDFStock
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation modules.

Static Public Member Functions inherited from ModelePDFSuppliersPayments
static	liste_modeles ($db, $maxfilenamelength=0)
	Return list of active generation models.

Detailed Description

Class to generate expense report based on standard model.

Class to generate the supplier invoices payment file with the standard model.

Class to build documents using ODF templates generator.

Class to generate stick sheet with format Avery or other personalised.

Class to generate Evaluation Pdf based on standard model.

Definition at line 46 of file pdf_standard.modules.php.

Constructor & Destructor Documentation

◆ __construct() [1/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 100 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), name, pdf_getFormat(), and type.

◆ __construct() [2/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 88 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), name, pdf_getFormat(), and type.

◆ __construct() [3/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 49 of file pdf_standard.class.php.

References description, name, and type.

◆ __construct() [4/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 65 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), getDolGlobalString(), name, pdf_getFormat(), and type.

◆ __construct() [5/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 73 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), name, pdf_getFormat(), and type.

◆ __construct() [6/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 61 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), getDolGlobalString(), name, pdf_getFormat(), and type.

◆ __construct() [7/7]

pdf_standard::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Reimplemented from CommonDocGenerator.

Definition at line 87 of file pdf_standard.modules.php.

References description, getDolGlobalInt(), name, pdf_getFormat(), and type.

Member Function Documentation

◆ _pagefoot() [1/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
ExpenseReport	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 1126 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

Referenced by write_file(), write_file(), and write_file().

◆ _pagefoot() [2/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Evaluation	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 720 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

◆ _pagefoot() [3/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Object	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 1135 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

◆ _pagefoot() [4/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Product	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 876 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

◆ _pagefoot() [5/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Object	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 846 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

◆ _pagefoot() [6/6]

pdf_standard::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs,
			$hidefreetext = 0 )

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
PaiementFourn	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$hidefreetext	1=Hide free text

Returns: int Return height of bottom margin including footer text

Definition at line 819 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), and pdf_pagefoot().

◆ _pagehead() [1/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
ExpenseReport	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output

Returns: float|int Return topshift value

Definition at line 647 of file pdf_standard.modules.php.

References $object, dol_print_date(), dolGetFirstLastname(), getDolGlobalString(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), and pdf_watermark().

Referenced by write_file(), write_file(), and write_file().

◆ _pagehead() [2/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Evaluation	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output

Returns: float|int Return topshift value

Definition at line 527 of file pdf_standard.modules.php.

References $object, dol_print_date(), getDolGlobalString(), pdf_getHeightForLogo(), and pdf_getPDFFontSize().

◆ _pagehead() [3/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
PaiementFourn	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output

Returns: float|int Return topshift value

Definition at line 603 of file pdf_standard.modules.php.

References $object, getDolGlobalString(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), and pdfBuildThirdpartyName().

◆ _pagehead() [4/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs,
			$titlekey = "" )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Object	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output
string	$titlekey	Translation key to show as title of document

Returns: float|int Return topshift value

Definition at line 913 of file pdf_standard.modules.php.

References $object, dol_print_date(), dol_print_error(), getDolGlobalString(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), price(), and price2num().

◆ _pagehead() [5/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs,
			$titlekey = "" )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Product	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output
string	$titlekey	Translation key to show as title of document

Returns: float|int Return topshift value

Definition at line 711 of file pdf_standard.modules.php.

References $object, getDolGlobalInt(), getDolGlobalString(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), and pdf_writeLinkedObjects().

◆ _pagehead() [6/6]

pdf_standard::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs,
			$titlekey = "" )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Entrepot	$object	Object to show
int	$showaddress	0=no, 1=yes
Translate	$outputlangs	Object lang for output
string	$titlekey	Translation key to show as title of document

Returns: float|int Return topshift value

Definition at line 693 of file pdf_standard.modules.php.

References $object, dol_now(), dol_print_date(), dol_print_error(), getDolGlobalString(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), pdf_writeLinkedObjects(), price(), and price2num().

◆ _tableau() [1/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
int	$tab_top	Tab top
int	$tab_height	Tab height
int	$nexY	next y
Translate	$outputlangs	Output langs
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 896 of file pdf_standard.modules.php.

References getDolGlobalString(), and pdf_getPDFFontSize().

Referenced by write_file(), and write_file().

◆ _tableau() [2/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
int	$tab_top	Tab top
int	$tab_height	Tab height
int	$nexY	next y
Translate	$outputlangs	Output langs
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 648 of file pdf_standard.modules.php.

References getDolGlobalString().

◆ _tableau() [3/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
float \| int	$tab_top	Top position of table
float \| int	$tab_height	Height of table (rectangle)
int	$nexY	Y (not used)
Translate	$outputlangs	Langs object
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 792 of file pdf_standard.modules.php.

References getDolGlobalString(), and pdf_getPDFFontSize().

◆ _tableau() [4/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
float \| int	$tab_top	Top position of table
float \| int	$tab_height	Height of table (rectangle)
int	$nexY	Y (not used)
Translate	$outputlangs	Langs object
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 614 of file pdf_standard.modules.php.

References getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRect().

◆ _tableau() [5/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
float \| int	$tab_top	Top position of table
float \| int	$tab_height	Height of table (rectangle)
int	$nexY	Y (not used)
Translate	$outputlangs	Langs object
int	$hidetop	1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 589 of file pdf_standard.modules.php.

References getDolGlobalString(), pdf_getPDFFontSize(), and CommonDocGenerator\printRect().

◆ _tableau() [6/6]

pdf_standard::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = 0,
			$hidebottom = 0,
			$currency = '' )

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
integer	$tab_top	Top position of table
integer	$tab_height	Height of table (rectangle)
int	$nexY	Y (not used)
Translate	$outputlangs	Langs object
int	$hidetop	Hide top bar of array
int	$hidebottom	Hide bottom bar of array
string	$currency	Currency code

Returns: void

Definition at line 560 of file pdf_standard.modules.php.

References pdf_getPDFFontSize().

◆ _tableau_cheque()

pdf_standard::_tableau_cheque	(	&	$pdf,
			$object,
			$posy,
			$outputlangs )

protected

Show total to pay.

Parameters

TCPDF	$pdf	Object PDF
PaiementFourn	$object	Object PaiementFourn
int	$posy	Position depart
Translate	$outputlangs	Object langs

Returns: int Position pour suite

Definition at line 494 of file pdf_standard.modules.php.

References $object, dol_convertToWord(), pdf_getPDFFontSize(), price(), and price2num().

Referenced by write_file().

◆ Add_PDF_card()

pdf_standard::Add_PDF_card	(	&	$pdf,
			$textleft,
			$header,
			$footer,
			$outputlangs,
			$textright = '',
			$idmember = 0,
			$photo = '' )

Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

LOGO is replace with company logo
PHOTO is replace with photo provided as parameter

Parameters

TCPDF	$pdf	PDF
string	$textleft	Text left
string	$header	Header
string	$footer	Footer
Translate	$outputlangs	Output langs
string	$textright	Text right
int	$idmember	Id member
string	$photo	Photo (full path to image file used as replacement for key PHOTOS into left, right, header or footer text)

Returns: void

Definition at line 93 of file pdf_standard.class.php.

References CommonStickerGenerator\_Croix(), dol_getImageSize(), get_exdir(), and getDolGlobalString().

Referenced by write_file().

◆ addSticker()

pdf_standard::addSticker	(	&	$pdf,
			$outputlangs,
			$param )

Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

Parameters

TCPDF	$pdf	PDF reference
Translate	$outputlangs	Output langs
array	$param	Associative array containing label content and optional parameters

Returns: void

Reimplemented from CommonStickerGenerator.

Definition at line 72 of file pdf_standard.class.php.

◆ printLine() [1/2]

pdf_standard::printLine	(	&	$pdf,
			$object,
			$linenumber,
			$curY,
			$default_font_size,
			$outputlangs,
			$hidedetails = 0 )

protected

Parameters

TCPDF	$pdf	Object PDF
ExpenseReport	$object	Object to show
int	$linenumber	line number
int	$curY	current y position
int	$default_font_size	default font size
Translate	$outputlangs	Object lang for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns: void

Definition at line 560 of file pdf_standard.modules.php.

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

Referenced by write_file().

◆ printLine() [2/2]

pdf_standard::printLine	(	&	$pdf,
			$object,
			$linenumber,
			$curY,
			$default_font_size,
			$outputlangs,
			$hidedetails = 0 )

protected

Parameters

TCPDF	$pdf	Object PDF
Evaluation	$object	Object to show
int	$linenumber	line number
int	$curY	current y position
int	$default_font_size	default font size
Translate	$outputlangs	Object lang for output
int	$hidedetails	Hide details (0=no, 1=yes, 2=just special lines)

Returns: void

Definition at line 463 of file pdf_standard.modules.php.

References $object.

◆ tablePayments()

pdf_standard::tablePayments	(	&	$pdf,
			$object,
			$posy,
			$outputlangs )

protected

Show payments table.

Parameters

TCPDF	$pdf	Object PDF
ExpenseReport	$object	Object expensereport
int	$posy	Position y in PDF
Translate	$outputlangs	Object langs for output

Returns: int Return integer <0 if KO, >0 if OK

Definition at line 1015 of file pdf_standard.modules.php.

References $object, dol_print_date(), pdf_getPDFFontSize(), and price().

Referenced by write_file().

◆ write_file() [1/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath,
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build a document on disk using the generic odt module.

Parameters

Product	$object	Object source to build document
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1 if OK, <=0 if KO

Definition at line 119 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), get_exdir(), getDolGlobalInt(), getDolGlobalString(), make_substitutions(), measuringUnitString(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSizeForImage(), and pdf_getSubstitutionArray().

◆ write_file() [2/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath,
		$mode = 'member',
		$nooutput = 0,
		$filename = 'tmp_cards' )

Function to build PDF on disk, then output on HTTP stream.

Parameters

Adherent \| array	$object	Member object. Old usage: Array of record information (array('textleft'=>,'textheader'=>, ...'id'=>,'photo'=>)
Translate	$outputlangs	Lang object for output language
string	$srctemplatepath	Full path of source filename for generator using a template file. Example: '5161', 'AVERYC32010', 'CARD', ...
string	$mode	Tell if doc module is called for 'member', ...
int	$nooutput	1=Generate only file on disk and do not return it on response
string	$filename	Name of output file (without extension)

Returns: int 1=OK, 0=KO

Definition at line 274 of file pdf_standard.class.php.

References $object, CommonStickerGenerator\_Set_Format(), Add_PDF_card(), complete_substitutions_array(), dol_mimetype(), dol_mkdir(), dol_now(), dol_print_date(), dol_print_error(), dolChmod(), get_exdir(), getDolGlobalString(), make_substitutions(), pdf_getInstance(), pdf_getPDFFont(), and type.

◆ write_file() [3/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build pdf onto disk.

Parameters

ExpenseReport	$object	Object to generate
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1=OK, 0=KO

Definition at line 188 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), getDolGlobalInt(), getDolGlobalString(), make_substitutions(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), price(), printLine(), and tablePayments().

◆ write_file() [4/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build pdf onto disk.

Parameters

Evaluation	$object	Object to generate
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1=OK, 0=KO

Definition at line 144 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), getDolGlobalInt(), getDolGlobalString(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), and printLine().

◆ write_file() [5/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build a document on disk using the generic odt module.

Parameters

MouvementStock	$object	Object source to build document
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1 if OK, <=0 if KO

TODO: get from object

footer table

Definition at line 138 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_get_first_day(), dol_get_last_day(), dol_htmlentitiesbr(), dol_mkdir(), dol_print_date(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), GETPOSTINT(), make_substitutions(), natural_search(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), pdf_writelinedesc(), and price2num().

◆ write_file() [6/7]

pdf_standard::write_file	(	$object,
		$outputlangs,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build a document on disk using the generic odt module.

Parameters

Entrepot	$object	Object source to build document
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1 if OK, <=0 if KO

Footer table

Definition at line 134 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_htmlentitiesbr(), dol_mkdir(), dol_print_error(), dol_sanitizeFileName(), dol_trunc(), dolChmod(), getDolGlobalInt(), getDolGlobalString(), make_substitutions(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), price(), and price2num().

◆ write_file() [7/7]

pdf_standard::write_file	(	$object,
		$outputlangs = null,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build pdf onto disk.

Parameters

PaiementFourn	$object	Id of object to generate
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename for generator using a template file
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: int 1=OK, 0=KO

Supplier invoice list

Definition at line 158 of file pdf_standard.modules.php.

References $object, _pagefoot(), _pagehead(), _tableau(), _tableau_cheque(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), getDolGlobalInt(), getDolGlobalString(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), and price().

The documentation for this class was generated from the following files:

dolibarr_20.0/htdocs/core/modules/expensereport/doc/pdf_standard.modules.php
dolibarr_20.0/htdocs/core/modules/hrm/doc/pdf_standard.modules.php
dolibarr_20.0/htdocs/core/modules/member/doc/pdf_standard.class.php
dolibarr_20.0/htdocs/core/modules/movement/doc/pdf_standard.modules.php
dolibarr_20.0/htdocs/core/modules/product/doc/pdf_standard.modules.php
dolibarr_20.0/htdocs/core/modules/stock/doc/pdf_standard.modules.php
dolibarr_20.0/htdocs/core/modules/supplier_payment/doc/pdf_standard.modules.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct() [1/7]

◆ __construct() [2/7]

◆ __construct() [3/7]

◆ __construct() [4/7]

◆ __construct() [5/7]

◆ __construct() [6/7]

◆ __construct() [7/7]

Member Function Documentation

◆ _pagefoot() [1/6]

◆ _pagefoot() [2/6]

◆ _pagefoot() [3/6]

◆ _pagefoot() [4/6]

◆ _pagefoot() [5/6]

◆ _pagefoot() [6/6]

◆ _pagehead() [1/6]

◆ _pagehead() [2/6]

◆ _pagehead() [3/6]

◆ _pagehead() [4/6]

◆ _pagehead() [5/6]

◆ _pagehead() [6/6]

◆ _tableau() [1/6]

◆ _tableau() [2/6]

◆ _tableau() [3/6]

◆ _tableau() [4/6]

◆ _tableau() [5/6]

◆ _tableau() [6/6]

◆ _tableau_cheque()

◆ Add_PDF_card()

◆ addSticker()

◆ printLine() [1/2]

◆ printLine() [2/2]

◆ tablePayments()

◆ write_file() [1/7]

◆ write_file() [2/7]

◆ write_file() [3/7]

◆ write_file() [4/7]

◆ write_file() [5/7]

◆ write_file() [6/7]

◆ write_file() [7/7]