dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
pdf_baleine Class Reference

Class to manage generation of project document Baleine. More...

+ Inheritance diagram for pdf_baleine:
+ Collaboration diagram for pdf_baleine:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs)
 Fonction generant le projet sur le disque. 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...
 
 columnSort ($a, $b)
 uasort callback function to Sort colums 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=false, $insertAfterTarget=false)
 get column position rank from column key More...
 
 printStdColumnContent ($pdf, &$curY, $colKey, $columnText='')
 print standard column content More...
 
 getColumnStatus ($colKey)
 get column status from column key More...
 

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

Additional Inherited Members

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

Detailed Description

Class to manage generation of project document Baleine.

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

Constructor & Destructor Documentation

◆ __construct()

pdf_baleine::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 119 of file pdf_baleine.modules.php.

Member Function Documentation

◆ _pagefoot()

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

Show footer of page.

Need this->emetteur object

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

Definition at line 671 of file pdf_baleine.modules.php.

◆ _pagehead()

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

Show top header of page.

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

Definition at line 578 of file pdf_baleine.modules.php.

◆ _tableau()

pdf_baleine::_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 531 of file pdf_baleine.modules.php.

◆ write_file()

pdf_baleine::write_file (   $object,
  $outputlangs 
)

Fonction generant le projet sur le disque.

Parameters
Project$objectObject project a generer
Translate$outputlangsLang output object
Returns
int 1 if OK, <=0 if KO

Definition at line 176 of file pdf_baleine.modules.php.


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