dolibarr 20.0.0
html_cerfafr Class Reference

Class to generate document for subscriptions. More...

Inheritance diagram for html_cerfafr:
Collaboration diagram for html_cerfafr:

Public Member Functions

 __construct ($db)
 Constructor.
 
 isEnabled ()
 Return if a module can be used or not.
 
 write_file ($don, $outputlangs, $currency='')
 Write the object to document file to 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.
 

Private Member Functions

 amountToLetters ($montant, $devise1='', $devise2='')
 numbers to letters
 

Additional Inherited Members

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

Detailed Description

Class to generate document for subscriptions.

Definition at line 37 of file html_cerfafr.modules.php.

Constructor & Destructor Documentation

◆ __construct()

html_cerfafr::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 44 of file html_cerfafr.modules.php.

References description, name, and type.

Member Function Documentation

◆ amountToLetters()

html_cerfafr::amountToLetters ( $montant,
$devise1 = '',
$devise2 = '' )
private

numbers to letters

Parameters
mixed$montantamount
mixed$devise1devise 1 ex: euro
mixed$devise2devise 2 ex: centimes
Returns
string amount in letters

Definition at line 267 of file html_cerfafr.modules.php.

Referenced by write_file().

◆ isEnabled()

html_cerfafr::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 62 of file html_cerfafr.modules.php.

◆ write_file()

html_cerfafr::write_file ( $don,
$outputlangs,
$currency = '' )

Write the object to document file to disk.

Parameters
Don$donDonation object
Translate$outputlangsLang object for output language
string$currencyCurrency code
Returns
int >0 if OK, <0 if KO

Definition at line 77 of file html_cerfafr.modules.php.

References amountToLetters(), dol_mkdir(), dol_now(), dol_print_date(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), getDolGlobalInt(), and price().


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