Class to generate PDF proposal Cyan. More...

Inheritance diagram for pdf_cyan:

Collaboration diagram for pdf_cyan:

Public Member Functions
	__construct ($db)
	Constructor. More...

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

	drawInfoTable (&$pdf, $object, $posy, $outputlangs)
	Show miscellaneous information (payment mode, payment term, ...) More...

	defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Define Array Column Field. More...

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

	get_substitutionarray_user ($user, $outputlangs)
	Define array with couple substitution key => substitution value. More...

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

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

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

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

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

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

	get_substitutionarray_lines ($line, $outputlangs, $linenumber=0)
	Define array with couple substitution key => substitution value. More...

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

	get_substitutionarray_shipment_lines ($line, $outputlangs)
	Define array with couple substitution key => substitution value. More...

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

	fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
	Fill array with couple extrafield key => extrafield value. More...

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

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

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

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

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

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

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

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

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

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

	getColumnStatus ($colKey)
	get column status from column key More...

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

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

Protected Member Functions
	drawPaymentsTable (&$pdf, $object, $posy, $outputlangs)
	Show payments table. More...

	drawTotalTable (&$pdf, $object, $deja_regle, $posy, $outputlangs)
	Show total to pay. More...

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

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

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

	drawSignatureArea (&$pdf, $object, $posy, $outputlangs)
	Show area for the customer to sign. More...

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

Detailed Description

Class to generate PDF proposal Cyan.

Definition at line 42 of file pdf_cyan.modules.php.

Constructor & Destructor Documentation

pdf_cyan::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 133 of file pdf_cyan.modules.php.

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

Member Function Documentation

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

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
Propal	$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 1785 of file pdf_cyan.modules.php.

References pdf_pagefoot().

Referenced by write_file().

pdf_cyan::_pagehead	(	&	$pdf,
			$object,
			$showaddress,
			$outputlangs,
			$outputlangsbis = `null`
	)

protected

Show top header of page.

Parameters

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

Returns: void

Definition at line 1519 of file pdf_cyan.modules.php.

References db, dol_print_date(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), pdf_writeLinkedObjects(), and pdfBuildThirdpartyName().

Referenced by write_file().

pdf_cyan::_tableau	(	&	$pdf,
			$tab_top,
			$tab_height,
			$nexY,
			$outputlangs,
			$hidetop = `0`,
			$hidebottom = `0`,
			$currency = `''`,
			$outputlangsbis = `null`
	)

protected

Show table for lines.

Parameters

TCPDF	$pdf	Object PDF
string	$tab_top	Top position of table
string	$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
Translate	$outputlangsbis	Langs object bis

Returns: void

Definition at line 1464 of file pdf_cyan.modules.php.

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

Referenced by write_file().

pdf_cyan::defineColumnField	(	$object,
		$outputlangs,
		$hidedetails = `0`,
		$hidedesc = `0`,
		$hideref = `0`
	)

Define Array Column Field.

Parameters

Propal	$object	object proposal
Translate	$outputlangs	langs
int	$hidedetails	Do not show line details
int	$hidedesc	Do not show desc
int	$hideref	Do not show ref

Returns: null

Definition at line 1838 of file pdf_cyan.modules.php.

References CommonDocGenerator\defineColumnExtrafield(), dol_string_nohtmltag(), dol_strlen(), pdf_getlineupexcltax(), and setEventMessages().

pdf_cyan::drawInfoTable	(	&	$pdf,
			$object,
			$posy,
			$outputlangs
	)

Show miscellaneous information (payment mode, payment term, ...)

Parameters

TCPDF	$pdf	Object PDF
Propal	$object	Object to show
int	$posy	Y
Translate	$outputlangs	Langs object

Returns: int Pos y

Definition at line 992 of file pdf_cyan.modules.php.

References db, dol_print_date(), pdf_bank(), and pdf_getPDFFontSize().

Referenced by write_file().

pdf_cyan::drawPaymentsTable	(	&	$pdf,
			$object,
			$posy,
			$outputlangs
	)

protected

Show payments table.

Parameters

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

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

Definition at line 979 of file pdf_cyan.modules.php.

pdf_cyan::drawSignatureArea	(	&	$pdf,
			$object,
			$posy,
			$outputlangs
	)

protected

Show area for the customer to sign.

Parameters

TCPDF	$pdf	Object PDF
Propal	$object	Object proposal
int	$posy	Position depart
Translate	$outputlangs	Objet langs

Returns: int Position pour suite

Definition at line 1801 of file pdf_cyan.modules.php.

References pdf_getPDFFontSize().

Referenced by write_file().

pdf_cyan::drawTotalTable	(	&	$pdf,
			$object,
			$deja_regle,
			$posy,
			$outputlangs
	)

protected

Show total to pay.

Parameters

TCPDF	$pdf	Object PDF
Propal	$object	Object proposal
int	$deja_regle	Amount already paid (in the currency of invoice)
int	$posy	Position depart
Translate	$outputlangs	Objet langs

Returns: int Position pour suite

Definition at line 1171 of file pdf_cyan.modules.php.

References if, pdf_getPDFFontSize(), price(), and vatrate().

Referenced by write_file().

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

Function to build pdf onto disk.

Parameters

Propal	$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 198 of file pdf_cyan.modules.php.

References _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), db, dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dol_syslog(), drawInfoTable(), drawSignatureArea(), drawTotalTable(), get_exdir(), CommonDocGenerator\getColumnContentXStart(), CommonDocGenerator\getColumnStatus(), CommonDocGenerator\getExtrafieldContent(), getLocalTaxesFromRate(), if, make_substitutions(), pdf_getInstance(), pdf_getlineqty(), pdf_getlineremisepercent(), pdf_getlinetotalexcltax(), pdf_getlinetotalwithtax(), pdf_getlineunit(), pdf_getlineupexcltax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSizeForImage(), pdf_getSubstitutionArray(), pdfGetHeightForHtmlContent(), CommonDocGenerator\pdfTabTitles(), CommonDocGenerator\prepareArrayColumnField(), CommonDocGenerator\printColDescContent(), CommonDocGenerator\printStdColumnContent(), and setEventMessages().

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

htdocs/core/modules/propale/doc/pdf_cyan.modules.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation