BordereauChequeBlochet Class Reference

Class of file to build cheque deposit receipts. More...

Inheritance diagram for BordereauChequeBlochet:

Collaboration diagram for BordereauChequeBlochet:

Public Member Functions
	__construct ($db)
	Constructor.
	write_file ($object, $_dir, $number, $outputlangs)
	Fonction to generate document on disk.
	Header (&$pdf, $page, $pages, $outputlangs)
	Generate Header.
	Body (&$pdf, $pagenb, $pages, $outputlangs)
	Output array.
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.
	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the 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
	_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
	Show footer of page.

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

Detailed Description

Class of file to build cheque deposit receipts.

Definition at line 38 of file pdf_blochet.class.php.

Constructor & Destructor Documentation

__construct()

BordereauChequeBlochet::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

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

References dol_syslog(), getCallerInfoString(), getDolGlobalInt(), name, pdf_getFormat(), and type.

Member Function Documentation

_pagefoot()

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

protected

Show footer of page.

Need this->emetteur object

Parameters

TCPDF	$pdf	PDF
?CommonObject	$object	Object to show
Translate	$outputlangs	Object lang for output
	int<0,1>	$hidefreetext 1=Hide free text

Returns

int

Definition at line 433 of file pdf_blochet.class.php.

References $conf, $object, complete_substitutions_array(), getDolGlobalInt(), getDolGlobalString(), make_substitutions(), pdf_getSubstitutionArray(), and pdf_pagefoot().

Referenced by write_file().

Body()

BordereauChequeBlochet::Body	(	&	$pdf,
			$pagenb,
			$pages,
			$outputlangs )

Output array.

Parameters

TCPDF	$pdf	PDF object
int	$pagenb	Page nb
int	$pages	Pages
Translate	$outputlangs	Object lang

Returns

void

Definition at line 362 of file pdf_blochet.class.php.

References Header(), pdf_getPDFFontSize(), and price().

Referenced by write_file().

Header()

BordereauChequeBlochet::Header	(	&	$pdf,
			$page,
			$pages,
			$outputlangs )

Generate Header.

Parameters

TCPDF	$pdf	Pdf object
int	$page	Current page number
int	$pages	Total number of pages
Translate	$outputlangs	Object language for output

Returns

void

Definition at line 254 of file pdf_blochet.class.php.

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

Referenced by Body(), and write_file().

write_file()

BordereauChequeBlochet::write_file	(		$object,
			$_dir,
			$number,
			$outputlangs )

Fonction to generate document on disk.

Parameters

RemiseCheque	$object	Object RemiseCheque
string	$_dir	Directory
string	$number	Number
Translate	$outputlangs	Lang output object

Returns

int<-1,1> 1 if OK, <=0 if KO

Reimplemented from ModeleChequeReceipts.

Definition at line 121 of file pdf_blochet.class.php.

References $conf, $object, _pagefoot(), Body(), dol_mkdir(), dolChmod(), get_exdir(), getDolGlobalInt(), getDolGlobalString(), Header(), pdf_getInstance(), and pdf_getPDFFont().

---

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

• dolibarr_dev/htdocs/core/modules/cheque/doc/pdf_blochet.class.php