dolibarr  7.0.0-beta
Public Member Functions | List of all members
pdf_soleil Class Reference

Class to build interventions documents with model Soleil. More...

+ Inheritance diagram for pdf_soleil:
+ Collaboration diagram for pdf_soleil:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto disk. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0)
 Show table for lines. More...
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs)
 Show top header of page. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
- Public Member Functions inherited from CommonDocGenerator
 __construct ($db)
 Constructor. More...
 
 get_substitutionarray_user ($user, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_mysoc ($mysoc, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_thirdparty ($object, $outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_contact ($object, $outputlangs, $array_key= 'object')
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_other ($outputlangs)
 Define array with couple subtitution key => subtitution value. More...
 
 get_substitutionarray_object ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_lines ($line, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_shipment ($object, $outputlangs, $array_key='object')
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_shipment_lines ($line, $outputlangs)
 Define array with couple substitution key => substitution value. More...
 
 get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=true)
 Define array with couple subtitution key => subtitution value. More...
 
 fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs)
 Fill array with couple extrafield key => extrafield value. More...
 
 printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0)
 Rect pdf. More...
 

Additional Inherited Members

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

Detailed Description

Class to build interventions documents with model Soleil.

Definition at line 39 of file pdf_soleil.modules.php.

Constructor & Destructor Documentation

pdf_soleil::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

References description, name, pdf_getFormat(), and type.

Member Function Documentation

pdf_soleil::_pagefoot ( $pdf,
  $object,
  $outputlangs,
  $hidefreetext = 0 
)

Show footer of page.

Need this->emetteur object

Parameters
PDF$pdfPDF
Object$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
integer

Definition at line 670 of file pdf_soleil.modules.php.

References pdf_pagefoot().

Referenced by write_file().

pdf_soleil::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs 
)

Show top header of page.

Parameters
PDF$pdfObject PDF
Object$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
void

Definition at line 492 of file pdf_soleil.modules.php.

References $title, dol_print_date(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), and pdfBuildThirdpartyName().

Referenced by write_file().

pdf_soleil::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0 
)

Show table for lines.

Parameters
PDF$pdfObject PDF
string$tab_topTop position of table
string$tab_heightHeight of table (rectangle)
int$nexYY
Translate$outputlangsLangs object
int$hidetopHide top bar of array
int$hidebottomHide bottom bar of array
Returns
void

Definition at line 432 of file pdf_soleil.modules.php.

References pdf_getPDFFontSize(), and CommonDocGenerator\printRect().

Referenced by write_file().

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

Function to build pdf onto disk.

Parameters
Object$objectObject to generate
Translate$outputlangsLang output object
string$srctemplatepathFull path of source filename for generator using a template file
int$hidedetailsDo not show line details
int$hidedescDo not show desc
int$hiderefDo not show ref
Returns
int 1=OK, 0=KO

Definition at line 108 of file pdf_soleil.modules.php.

References _pagefoot(), _pagehead(), _tableau(), convertSecondToTime(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_print_date(), dol_sanitizeFileName(), pdf_getInstance(), pdf_getPDFFont(), and pdf_getPDFFontSize().


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