dolibarr 21.0.0-beta
ModelePDFMyObject Class Reference

Parent class for document models. More...

Inheritance diagram for ModelePDFMyObject:
Collaboration diagram for ModelePDFMyObject:

Public Member Functions

 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk.
 
- Public Member Functions inherited from CommonDocGenerator
 __construct ($db)
 Constructor.
 
 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.
 
 printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
 Print a rounded rectangle on the 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.
 

Static Public Member Functions

static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules.
 

Detailed Description

Parent class for document models.

Definition at line 40 of file modules_myobject.php.

Member Function Documentation

◆ liste_modeles()

static ModelePDFMyObject::liste_modeles ( $db,
$maxfilenamelength = 0 )
static

Return list of active generation modules.

Parameters
DoliDB$dbDatabase handler
int<0,max>$maxfilenamelength Max length of value to show
Returns
string[]|int<-1,0> List of templates

Reimplemented in pdf_standard_myobject.

Definition at line 50 of file modules_myobject.php.

References getListOfModels().

◆ write_file()

ModelePDFMyObject::write_file ( $object,
$outputlangs,
$srctemplatepath = '',
$hidedetails = 0,
$hidedesc = 0,
$hideref = 0 )
abstract

Function to build a document on disk.

Parameters
MyObject$objectObject source to build document
Translate$outputlangsLang output object
string$srctemplatepathFull path of source filename for generator using a template file
int<0,1>$hidedetails Do not show line details
int<0,1>$hidedesc Do not show desc
int<0,1>$hideref Do not show ref
Returns
int<-1,1> 1 if OK, <=0 if KO

Reimplemented in doc_generic_myobject_odt, and pdf_standard_myobject.


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