dolibarr 25.0.0-alpha
pdf_standard_donation Class Reference

Class to generate a PDF donation receipt with the standard model. More...

Inheritance diagram for pdf_standard_donation:
Collaboration diagram for pdf_standard_donation:

Public Member Functions

 __construct ($db)
 Constructor.
 
 isEnabled ()
 Return if a module can be used or not.
 
 write_file ($don, $outputlangs, $currency='')
 Write the donation receipt to a PDF file on disk.
 
- Public Member Functions inherited from ModeleDon
 getDonorInfos ($don, $outputlangs)
 Return the identity of the donor of a donation.
 
- 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 @phpstan-template T.
 
 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.
 
 getMaxAfterColsLinePositionsData ()
 Get position in PDF after col display.
 
 resetAfterColsLinePositionsData (float $y, int $pageNumb)
 Used for reset afterColsLinePositions var in start of a new pdf draw line loop.
 
 setAfterColsLinePositionsData (string $colId, float $y, int $pageNumb)
 Used for to set afterColsLinePositions var in a pdf draw line loop.
 
 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
 
 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.
 
 mustAddTermsOfSale ($object, $type)
 Return if the terms of sale file must be concatenated to the generated document.
 

Protected Member Functions

 tableauDon (&$pdf, $don, $posy, $outputlangs, $currency)
 Show the amount and the details of the donation.
 
 signatureArea (&$pdf, $don, $posy, $outputlangs)
 Show the place, date and signature area of the receipt.
 
 _pagehead (&$pdf, $don, $donor, $outputlangs)
 Show top header of page.
 
 _pagefoot (&$pdf, $don, $outputlangs, $hidefreetext=0)
 Show footer of page.
 

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 a PDF donation receipt with the standard model.

This receipt is not linked to a national tax form, so it can be used in any country.

Definition at line 34 of file pdf_standard_donation.modules.php.

Constructor & Destructor Documentation

◆ __construct()

pdf_standard_donation::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Definition at line 58 of file pdf_standard_donation.modules.php.

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

Member Function Documentation

◆ _pagefoot()

pdf_standard_donation::_pagefoot ( & $pdf,
$don,
$outputlangs,
$hidefreetext = 0 )
protected

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Don$donDonation object
Translate$outputlangsObject lang for output
int<0,1>$hidefreetext 1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 501 of file pdf_standard_donation.modules.php.

References getDolGlobalInt(), and pdf_pagefoot().

Referenced by write_file().

◆ _pagehead()

pdf_standard_donation::_pagehead ( & $pdf,
$don,
$donor,
$outputlangs )
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
Don$donDonation object
array{company:string,lastname:string,firstname:string,name:string,address:string,zip:string,town:string,country_code:string,country:string,idprof1:string,thirdparty:?Societe}$donor Identity of the donor
Translate$outputlangsObject lang for output
Returns
float Y position after the header

Definition at line 370 of file pdf_standard_donation.modules.php.

References $conf, dol_now(), dol_print_date(), getDolGlobalInt(), getDolGlobalString(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), and pdf_pagehead().

Referenced by write_file().

◆ isEnabled()

pdf_standard_donation::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Reimplemented from ModeleDon.

Definition at line 98 of file pdf_standard_donation.modules.php.

◆ signatureArea()

pdf_standard_donation::signatureArea ( & $pdf,
$don,
$posy,
$outputlangs )
protected

Show the place, date and signature area of the receipt.

Parameters
TCPDF$pdfObject PDF
Don$donDonation object
float$posyY position to start
Translate$outputlangsObject lang for output
Returns
float Y position after the block

Definition at line 332 of file pdf_standard_donation.modules.php.

References dol_now(), dol_print_date(), and pdf_getPDFFontSize().

Referenced by write_file().

◆ tableauDon()

pdf_standard_donation::tableauDon ( & $pdf,
$don,
$posy,
$outputlangs,
$currency )
protected

Show the amount and the details of the donation.

Parameters
TCPDF$pdfObject PDF
Don$donDonation object
float$posyY position to start
Translate$outputlangsObject lang for output
string$currencyCurrency code
Returns
float Y position after the block

Definition at line 272 of file pdf_standard_donation.modules.php.

References dol_convertToWord(), dol_print_date(), isModEnabled(), pdf_getPDFFontSize(), price(), and price2num().

Referenced by write_file().

◆ write_file()

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

Write the donation receipt to a PDF file on disk.

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

Reimplemented from ModeleDon.

Definition at line 113 of file pdf_standard_donation.modules.php.

References $conf, $id, _pagefoot(), _pagehead(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dolChmod(), getDolGlobalString(), ModeleDon\getDonorInfos(), make_substitutions(), pdf_getInstance(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), signatureArea(), and tableauDon().


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