dolibarr  21.0.0-alpha
Public Member Functions | Protected Member Functions | List of all members
pdf_standard Class Reference

Class to generate expense report based on standard model. More...

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

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...
 
 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto disk. More...
 
 __construct ($db)
 Constructor. More...
 
 addSticker (&$pdf, $outputlangs, $param)
 Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0) More...
 
 Add_PDF_card (&$pdf, $textleft, $header, $footer, $outputlangs, $textright='', $idmember=0, $photo='')
 Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0) More...
 
 write_file ($object, $outputlangs, $srctemplatepath, $mode='member', $nooutput=0, $filename='tmp_cards')
 Function to build PDF on disk, then output on HTTP stream. More...
 
 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk using the generic odt module. More...
 
 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk using the generic odt module. More...
 
 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build a document on disk using the generic odt module. More...
 
 __construct ($db)
 Constructor. More...
 
 write_file ($object, $outputlangs=null, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Function to build pdf onto 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...
 
- Public Member Functions inherited from CommonStickerGenerator
 write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='')
 Function to build PDF on disk, then output on HTTP stream. More...
 
 Set_Char_Size (&$pdf, $pt)
 Method to modify the size of characters This will also modify the space between lines. More...
 

Protected Member Functions

 printLine (&$pdf, $object, $linenumber, $curY, $default_font_size, $outputlangs, $hidedetails=0)
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs)
 Show top header of page. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines. More...
 
 tablePayments (&$pdf, $object, $posy, $outputlangs)
 Show payments table. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
 printLine (&$pdf, $object, $linenumber, $curY, $default_font_size, $outputlangs, $hidedetails=0)
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs)
 Show top header of page. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines. More...
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
 Show top header of page. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines. More...
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
 Show top header of page. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 Show table for lines. More...
 
 _pagehead (&$pdf, $object, $showaddress, $outputlangs, $titlekey="")
 Show top header of page. More...
 
 _pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0)
 Show footer of page. More...
 
 _tableau_cheque (&$pdf, $object, $posy, $outputlangs)
 Show total to pay. More...
 
 _tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='')
 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...
 
- Protected Member Functions inherited from CommonStickerGenerator
 _Pointille (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $nbPointilles=15)
 protected Print dot line More...
 
 _Croix (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $taille=4)
 protected Function realisant une croix aux 4 coins des cartes More...
 
 _Get_Height_Chars ($pt)
 protected Give the height for a char size given. More...
 
 _Set_Format (&$pdf, $format)
 protected Set format More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ModeleExpenseReport
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active models generation. More...
 
- Static Public Member Functions inherited from ModelePDFEvaluation
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules. More...
 
- Static Public Member Functions inherited from ModelePDFMovement
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules. More...
 
- Static Public Member Functions inherited from ModelePDFProduct
static liste_modeles ($dbs, $maxfilenamelength=0)
 Return list of active generation modules. More...
 
- Static Public Member Functions inherited from ModelePDFStock
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation modules. More...
 
- Static Public Member Functions inherited from ModelePDFSuppliersPayments
static liste_modeles ($db, $maxfilenamelength=0)
 Return list of active generation models. More...
 

Detailed Description

Class to generate expense report based on standard model.

Class to generate the supplier invoices payment file with the standard model.

Class to build documents using ODF templates generator.

Class to generate stick sheet with format Avery or other personalised.

Class to generate Evaluation Pdf based on standard model.

Definition at line 46 of file pdf_standard.modules.php.

Constructor & Destructor Documentation

◆ __construct() [1/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 100 of file pdf_standard.modules.php.

◆ __construct() [2/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 88 of file pdf_standard.modules.php.

◆ __construct() [3/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 49 of file pdf_standard.class.php.

◆ __construct() [4/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 65 of file pdf_standard.modules.php.

◆ __construct() [5/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

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

◆ __construct() [6/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 61 of file pdf_standard.modules.php.

◆ __construct() [7/7]

pdf_standard::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonStickerGenerator.

Definition at line 87 of file pdf_standard.modules.php.

Member Function Documentation

◆ _pagefoot() [1/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
ExpenseReport$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 1111 of file pdf_standard.modules.php.

◆ _pagefoot() [2/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Evaluation$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 720 of file pdf_standard.modules.php.

◆ _pagefoot() [3/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Object$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 1135 of file pdf_standard.modules.php.

◆ _pagefoot() [4/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Product$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 876 of file pdf_standard.modules.php.

◆ _pagefoot() [5/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
Object$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 846 of file pdf_standard.modules.php.

◆ _pagefoot() [6/6]

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

Show footer of page.

Need this->emetteur object

Parameters
TCPDF$pdfPDF
PaiementFourn$objectObject to show
Translate$outputlangsObject lang for output
int$hidefreetext1=Hide free text
Returns
int Return height of bottom margin including footer text

Definition at line 819 of file pdf_standard.modules.php.

◆ _pagehead() [1/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
ExpenseReport$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
float|int Return topshift value

Definition at line 632 of file pdf_standard.modules.php.

◆ _pagehead() [2/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
Evaluation$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
float|int Return topshift value

Definition at line 527 of file pdf_standard.modules.php.

◆ _pagehead() [3/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
PaiementFourn$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
Returns
float|int Return topshift value

Definition at line 603 of file pdf_standard.modules.php.

◆ _pagehead() [4/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs,
  $titlekey = "" 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
Object$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
string$titlekeyTranslation key to show as title of document
Returns
float|int Return topshift value

Definition at line 913 of file pdf_standard.modules.php.

◆ _pagehead() [5/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs,
  $titlekey = "" 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
Product$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
string$titlekeyTranslation key to show as title of document
Returns
float|int Return topshift value

Definition at line 711 of file pdf_standard.modules.php.

◆ _pagehead() [6/6]

pdf_standard::_pagehead ( $pdf,
  $object,
  $showaddress,
  $outputlangs,
  $titlekey = "" 
)
protected

Show top header of page.

Parameters
TCPDF$pdfObject PDF
Entrepot$objectObject to show
int$showaddress0=no, 1=yes
Translate$outputlangsObject lang for output
string$titlekeyTranslation key to show as title of document
Returns
float|int Return topshift value

Definition at line 693 of file pdf_standard.modules.php.

◆ _tableau() [1/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

Parameters
TCPDF$pdfObject PDF
int$tab_topTab top
int$tab_heightTab height
int$nexYnext y
Translate$outputlangsOutput langs
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 881 of file pdf_standard.modules.php.

◆ _tableau() [2/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

Parameters
TCPDF$pdfObject PDF
int$tab_topTab top
int$tab_heightTab height
int$nexYnext y
Translate$outputlangsOutput langs
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 648 of file pdf_standard.modules.php.

◆ _tableau() [3/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

Parameters
TCPDF$pdfObject PDF
float | int$tab_topTop position of table
float | int$tab_heightHeight of table (rectangle)
int$nexYY (not used)
Translate$outputlangsLangs object
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 792 of file pdf_standard.modules.php.

◆ _tableau() [4/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

Parameters
TCPDF$pdfObject PDF
float | int$tab_topTop position of table
float | int$tab_heightHeight of table (rectangle)
int$nexYY (not used)
Translate$outputlangsLangs object
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 614 of file pdf_standard.modules.php.

◆ _tableau() [5/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

Parameters
TCPDF$pdfObject PDF
float | int$tab_topTop position of table
float | int$tab_heightHeight of table (rectangle)
int$nexYY (not used)
Translate$outputlangsLangs object
int$hidetop1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title
int$hidebottomHide bottom bar of array
string$currencyCurrency code
Returns
void

Definition at line 589 of file pdf_standard.modules.php.

◆ _tableau() [6/6]

pdf_standard::_tableau ( $pdf,
  $tab_top,
  $tab_height,
  $nexY,
  $outputlangs,
  $hidetop = 0,
  $hidebottom = 0,
  $currency = '' 
)
protected

Show table for lines.

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

Definition at line 560 of file pdf_standard.modules.php.

◆ _tableau_cheque()

pdf_standard::_tableau_cheque ( $pdf,
  $object,
  $posy,
  $outputlangs 
)
protected

Show total to pay.

Parameters
TCPDF$pdfObject PDF
PaiementFourn$objectObject PaiementFourn
int$posyPosition depart
Translate$outputlangsObject langs
Returns
int Position pour suite

Definition at line 494 of file pdf_standard.modules.php.

◆ Add_PDF_card()

pdf_standard::Add_PDF_card ( $pdf,
  $textleft,
  $header,
  $footer,
  $outputlangs,
  $textright = '',
  $idmember = 0,
  $photo = '' 
)

Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

  • LOGO is replace with company logo
  • PHOTO is replace with photo provided as parameter
Parameters
TCPDF$pdfPDF
string$textleftText left
string$headerHeader
string$footerFooter
Translate$outputlangsOutput langs
string$textrightText right
int$idmemberId member
string$photoPhoto (full path to image file used as replacement for key PHOTOS into left, right, header or footer text)
Returns
void

Definition at line 93 of file pdf_standard.class.php.

◆ addSticker()

pdf_standard::addSticker ( $pdf,
  $outputlangs,
  $param 
)

Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)

Parameters
TCPDF$pdfPDF reference
Translate$outputlangsOutput langs
array$paramAssociative array containing label content and optional parameters
Returns
void

Reimplemented from CommonStickerGenerator.

Definition at line 72 of file pdf_standard.class.php.

◆ printLine() [1/2]

pdf_standard::printLine ( $pdf,
  $object,
  $linenumber,
  $curY,
  $default_font_size,
  $outputlangs,
  $hidedetails = 0 
)
protected
Parameters
TCPDF$pdfObject PDF
ExpenseReport$objectObject to show
int$linenumberline number
int$curYcurrent y position
int$default_font_sizedefault font size
Translate$outputlangsObject lang for output
int$hidedetailsHide details (0=no, 1=yes, 2=just special lines)
Returns
void

Definition at line 545 of file pdf_standard.modules.php.

◆ printLine() [2/2]

pdf_standard::printLine ( $pdf,
  $object,
  $linenumber,
  $curY,
  $default_font_size,
  $outputlangs,
  $hidedetails = 0 
)
protected
Parameters
TCPDF$pdfObject PDF
Evaluation$objectObject to show
int$linenumberline number
int$curYcurrent y position
int$default_font_sizedefault font size
Translate$outputlangsObject lang for output
int$hidedetailsHide details (0=no, 1=yes, 2=just special lines)
Returns
void

Definition at line 463 of file pdf_standard.modules.php.

◆ tablePayments()

pdf_standard::tablePayments ( $pdf,
  $object,
  $posy,
  $outputlangs 
)
protected

Show payments table.

Parameters
TCPDF$pdfObject PDF
ExpenseReport$objectObject expensereport
int$posyPosition y in PDF
Translate$outputlangsObject langs for output
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1000 of file pdf_standard.modules.php.

◆ write_file() [1/7]

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

Function to build a document on disk using the generic odt module.

Parameters
Product$objectObject source to build document
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 if OK, <=0 if KO

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

◆ write_file() [2/7]

pdf_standard::write_file (   $object,
  $outputlangs,
  $srctemplatepath,
  $mode = 'member',
  $nooutput = 0,
  $filename = 'tmp_cards' 
)

Function to build PDF on disk, then output on HTTP stream.

Parameters
Adherent | array$objectMember object. Old usage: Array of record information (array('textleft'=>,'textheader'=>, ...'id'=>,'photo'=>)
Translate$outputlangsLang object for output language
string$srctemplatepathFull path of source filename for generator using a template file. Example: '5161', 'AVERYC32010', 'CARD', ...
string$modeTell if doc module is called for 'member', ...
int$nooutput1=Generate only file on disk and do not return it on response
string$filenameName of output file (without extension)
Returns
int 1=OK, 0=KO

Definition at line 274 of file pdf_standard.class.php.

◆ write_file() [3/7]

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

Function to build pdf onto disk.

Parameters
ExpenseReport$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 188 of file pdf_standard.modules.php.

◆ write_file() [4/7]

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

Function to build pdf onto disk.

Parameters
Evaluation$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 144 of file pdf_standard.modules.php.

◆ write_file() [5/7]

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

Function to build a document on disk using the generic odt module.

Parameters
MouvementStock$objectObject source to build document
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 if OK, <=0 if KO

TODO: get from object

footer table

Definition at line 138 of file pdf_standard.modules.php.

◆ write_file() [6/7]

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

Function to build a document on disk using the generic odt module.

Parameters
Entrepot$objectObject source to build document
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 if OK, <=0 if KO

Footer table

Definition at line 134 of file pdf_standard.modules.php.

◆ write_file() [7/7]

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

Function to build pdf onto disk.

Parameters
PaiementFourn$objectId of object 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

Supplier invoice list

Definition at line 158 of file pdf_standard.modules.php.


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