pdf_baleine Class Reference

Class to manage generation of project document Baleine. More...

Inheritance diagram for pdf_baleine:

Collaboration diagram for pdf_baleine:

Public Member Functions
	__construct ($db)
	Constructor.
	write_file ($object, $outputlangs)
	Function to build pdf project 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.

Protected Member Functions
	_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0)
	Show table for lines.
	_pagehead (&$pdf, $object, $showaddress, $outputlangs)
	Show top header of page.
	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

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

Detailed Description

Class to manage generation of project document Baleine.

Definition at line 40 of file pdf_baleine.modules.php.

Constructor & Destructor Documentation

__construct()

pdf_baleine::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Definition at line 89 of file pdf_baleine.modules.php.

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

Member Function Documentation

_pagefoot()

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

protected

Show footer of page.

Need this->emetteur object

Parameters

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

Returns

integer

Definition at line 661 of file pdf_baleine.modules.php.

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

Referenced by write_file().

_pagehead()

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

protected

Show top header of page.

Parameters

TCPDF	$pdf	Object PDF
Project	$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 567 of file pdf_baleine.modules.php.

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

Referenced by write_file().

_tableau()

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

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
Translate	$outputlangs	Langs object
int	$hidetop	Hide top bar of array
int	$hidebottom	Hide bottom bar of array

Returns

void

Definition at line 517 of file pdf_baleine.modules.php.

References pdf_getPDFFontSize().

Referenced by write_file().

write_file()

pdf_baleine::write_file	(		$object,
			$outputlangs )

Function to build pdf project onto disk.

Parameters

Project	$object	Object project a generer
Translate	$outputlangs	Lang output object

Returns

int 1 if OK, <=0 if KO

Definition at line 147 of file pdf_baleine.modules.php.

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

---

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

• dolibarr_20.0/htdocs/core/modules/project/doc/pdf_baleine.modules.php