pdf_paiement Class Reference

Class to manage reporting of payments. More...

Inheritance diagram for pdf_paiement:

Collaboration diagram for pdf_paiement:

Public Member Functions
	__construct ($db)
	Constructor.
	write_file ($_dir, $month, $year, $outputlangs)
	Fonction generant la rapport sur le disque.
	Body (&$pdf, $page, $lines, $outputlangs)
	Output body.
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.

Protected Member Functions
	_pagehead (&$pdf, $page, $showaddress, $outputlangs)
	Show top header of page.

Detailed Description

Class to manage reporting of payments.

Definition at line 36 of file pdf_paiement.class.php.

Constructor & Destructor Documentation

__construct()

pdf_paiement::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Reimplemented in pdf_paiement_fourn.

Definition at line 71 of file pdf_paiement.class.php.

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

Member Function Documentation

_pagehead()

pdf_paiement::_pagehead ( & $pdf, $page, $showaddress, $outputlangs )

protected

Show top header of page.

Parameters

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

Returns

float|int Return topshift value

Definition at line 395 of file pdf_paiement.class.php.

References dol_mktime(), dol_print_date(), getDolGlobalString(), and pdf_getPDFFontSize().

Referenced by Body(), and write_file().

Body()

pdf_paiement::Body	(	&	$pdf,
			$page,
			$lines,
			$outputlangs )

Output body.

Parameters

TCPDF	$pdf	PDF object
string	$page	Page
array	$lines	Array of lines
Translate	$outputlangs	Object langs

Returns

void

Definition at line 470 of file pdf_paiement.class.php.

References _pagehead(), getDolGlobalString(), pdf_getPDFFontSize(), and price().

Referenced by write_file().

write_file()

pdf_paiement::write_file	(		$_dir,
			$month,
			$year,
			$outputlangs )

Fonction generant la rapport sur le disque.

Parameters

string	$_dir	repertoire
int	$month	mois du rapport
int	$year	annee du rapport
string	$outputlangs	Lang output object

Returns

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

Definition at line 127 of file pdf_paiement.class.php.

References _pagehead(), Body(), dol_get_first_day(), dol_get_last_day(), dol_mkdir(), dol_print_date(), dol_print_error(), dol_syslog(), dolChmod(), getDolGlobalString(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), and price().

---

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

• dolibarr_20.0/htdocs/core/modules/rapport/pdf_paiement.class.php