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

Class to manage reporting of payments. More...

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 write_file ($_dir, $month, $year, $outputlangs)
 Fonction generant la rapport sur le disque. More...
 
 Body (&$pdf, $page, $lines, $outputlangs)
 Output body. 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

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

Detailed Description

Class to manage reporting of payments.

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

Constructor & Destructor Documentation

◆ __construct()

pdf_paiement::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Reimplemented in pdf_paiement_fourn.

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

Member Function Documentation

◆ _pagehead()

pdf_paiement::_pagehead ( $pdf,
  $page,
  $showaddress,
  $outputlangs 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
int$pageObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
float|int Return topshift value

Definition at line 394 of file pdf_paiement.class.php.

◆ Body()

pdf_paiement::Body ( $pdf,
  $page,
  $lines,
  $outputlangs 
)

Output body.

Parameters
TCPDF$pdfPDF object
string$pagePage
array$linesArray of lines
Translate$outputlangsObject langs
Returns
void

Definition at line 469 of file pdf_paiement.class.php.

◆ write_file()

pdf_paiement::write_file (   $_dir,
  $month,
  $year,
  $outputlangs 
)

Fonction generant la rapport sur le disque.

Parameters
string$_dirrepertoire
int$monthmois du rapport
int$yearannee du rapport
string$outputlangsLang output object
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 126 of file pdf_paiement.class.php.


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