dolibarr  21.0.0-alpha
Public Member Functions | Protected Member Functions | List of all members
BordereauChequeBlochet Class Reference

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

Inheritance diagram for BordereauChequeBlochet:
Inheritance graph
[legend]
Collaboration diagram for BordereauChequeBlochet:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 write_file ($object, $_dir, $number, $outputlangs)
 Fonction to generate document on disk. More...
 
 Header (&$pdf, $page, $pages, $outputlangs)
 Generate Header. More...
 
 Body (&$pdf, $pagenb, $pages, $outputlangs)
 Output array. More...
 
- Public Member Functions inherited from CommonDocGenerator
 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 For example {company_name}, {company_name_alias}. 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_lines ($line, $outputlangs, $linenumber=0)
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. More...
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1)
 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 Note that vars into substitutions array are formatted. 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='', $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, $outputlangs=null)
 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...
 
 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. More...
 

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

Class of file to build cheque deposit receipts.

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

Constructor & Destructor Documentation

◆ __construct()

BordereauChequeBlochet::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

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

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Object$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
mixed

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

◆ Body()

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

Output array.

Parameters
TCPDF$pdfPDF object
int$pagenbPage nb
int$pagesPages
Translate$outputlangsObject lang
Returns
void

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

◆ Header()

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

Generate Header.

Parameters
TCPDF$pdfPdf object
int$pageCurrent page number
int$pagesTotal number of pages
Translate$outputlangsObject language for output
Returns
void

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

◆ write_file()

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

Fonction to generate document on disk.

Parameters
RemiseCheque$objectObject RemiseCheque
string$_dirDirectory
string$numberNumber
Translate$outputlangsLang output object
Returns
int 1=ok, 0=ko

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


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