Class to build a standard salary slip PDF. More...

Inheritance diagram for pdf_standard_salary:

Collaboration diagram for pdf_standard_salary:

Public Member Functions
	__construct (\DoliDB $db)
	Constructor.

	writeFile ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
	Function to build the salary slip document.

Public Member Functions inherited from CommonDocGenerator
	__construct ($db)
	Constructor.

	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 @phpstan-template T.

	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.

	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the PDF.

	getMaxAfterColsLinePositionsData ()
	Get position in PDF after col display.

	resetAfterColsLinePositionsData (float $y, int $pageNumb)
	Used for reset afterColsLinePositions var in start of a new pdf draw line loop.

	setAfterColsLinePositionsData (string $colId, float $y, int $pageNumb)
	Used for to set afterColsLinePositions var in a pdf draw line loop.

	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, $object, $outputlangs, $showaddress=1)
	Show top header of page.

	body (&$pdf, $object, $outputlangs)
	Show the lines of the salary slip.

	tableauHeader (&$pdf, $tab_top, $outputlangs)
	Show table header.

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

Additional Inherited Members
Static Public Member Functions inherited from ModelePDFSalary
static	listModels ($db, $maxfilenamelength=0)
	Return list of available salary PDF models.

static	liste_modeles ($db)
	Legacy method required by Dolibarr PDF system Delegates to camelCase method.

Detailed Description

Class to build a standard salary slip PDF.

Definition at line 26 of file pdf_standard_salary.modules.php.

Constructor & Destructor Documentation

◆ __construct()

pdf_standard_salary::__construct ( \DoliDB $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 78 of file pdf_standard_salary.modules.php.

References $conf, $db, $mysoc, description, getDolGlobalInt(), name, pdf_getFormat(), and type.

Member Function Documentation

◆ _pagefoot()

pdf_standard_salary::_pagefoot	(	&	$pdf,
			$object,
			$outputlangs )

protected

Show footer of page.

Parameters

TCPDF	$pdf	PDF object
object	$object	Object to show
Translate	$outputlangs	Object lang for output

Returns: void

Definition at line 410 of file pdf_standard_salary.modules.php.

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

Referenced by writeFile().

◆ _pagehead()

pdf_standard_salary::_pagehead	(	&	$pdf,
			$object,
			$outputlangs,
			$showaddress = 1 )

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Salary	$object	Object to show
Translate	$outputlangs	Object lang for output
int	$showaddress	Show address

Returns: void

Definition at line 183 of file pdf_standard_salary.modules.php.

References $conf, $object, dol_print_date(), isModEnabled(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), and pdf_pagehead().

Referenced by writeFile().

◆ body()

pdf_standard_salary::body	(	&	$pdf,
			$object,
			$outputlangs )

protected

Show the lines of the salary slip.

Parameters

TCPDF	$pdf	PDF object
object	$object	Salary object
Translate	$outputlangs	Language object

Returns: void

Definition at line 319 of file pdf_standard_salary.modules.php.

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

Referenced by writeFile().

◆ tableauHeader()

pdf_standard_salary::tableauHeader	(	&	$pdf,
			$tab_top,
			$outputlangs )

protected

Show table header.

Parameters

TCPDF	$pdf	Object PDF
float	$tab_top	Top position of table
Translate	$outputlangs	Langs object

Returns: void

Definition at line 384 of file pdf_standard_salary.modules.php.

References pdf_getPDFFontSize().

Referenced by body().

◆ writeFile()

pdf_standard_salary::writeFile	(	$object,
		$outputlangs,
		$srctemplatepath = '',
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0 )

Function to build the salary slip document.

Parameters

Salary	$object	Object source to build document
Translate	$outputlangs	Lang output object
string	$srctemplatepath	Full path of source filename
int	$hidedetails	Hide details
int	$hidedesc	Hide description
int	$hideref	Hide reference

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

Reimplemented from ModelePDFSalary.

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

References $conf, $object, _pagefoot(), _pagehead(), body(), dol_is_dir(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), getDolGlobalString(), pdf_getInstance(), and pdf_getPDFFont().

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

dolibarr_dev/htdocs/core/modules/salaries/doc/pdf_standard_salary.modules.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _pagefoot()

◆ _pagehead()

◆ body()

◆ tableauHeader()

◆ writeFile()