dolibarr  21.0.0-alpha
Public Member Functions | Private Member Functions | List of all members
html_generic Class Reference

Class to generate document for a generic donations receipt. More...

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

Public Member Functions

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

Private Member Functions

 loadTranslationFiles ($outputlangs)
 Load translation files. More...
 
 getDonationPaymentType ($don)
 Write the object to document file to disk. More...
 
 getContents ($don, $outputlangs, $currency)
 Get the contents of the file. More...
 
 saveFile ($path, $contents)
 Write the object to document file to disk. More...
 

Additional Inherited Members

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

Detailed Description

Class to generate document for a generic donations receipt.

Definition at line 38 of file html_generic.modules.php.

Constructor & Destructor Documentation

◆ __construct()

html_generic::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 45 of file html_generic.modules.php.

Member Function Documentation

◆ getContents()

html_generic::getContents (   $don,
  $outputlangs,
  $currency 
)
private

Get the contents of the file.

Parameters
Don$donDonation object
Translate$outputlangsLang object for output language
string$currencyCurrency code
Returns
string Contents of the file

Definition at line 116 of file html_generic.modules.php.

◆ getDonationPaymentType()

html_generic::getDonationPaymentType (   $don)
private

Write the object to document file to disk.

Parameters
Don$donDonation object
Returns
string Label for payment type

Definition at line 91 of file html_generic.modules.php.

◆ isEnabled()

html_generic::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_generic.modules.php.

◆ loadTranslationFiles()

html_generic::loadTranslationFiles (   $outputlangs)
private

Load translation files.

Parameters
Translate$outputlangsLang object for output language
Returns
Translate $outputlangs Lang object for output language

Definition at line 73 of file html_generic.modules.php.

◆ saveFile()

html_generic::saveFile (   $path,
  $contents 
)
private

Write the object to document file to disk.

Parameters
string$pathPath for the file
string$contentsContents of the file
Returns
int Return code

Definition at line 174 of file html_generic.modules.php.

◆ write_file()

html_generic::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 194 of file html_generic.modules.php.


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