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

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

+ Inheritance diagram for pdf_standardlabel:
+ Collaboration diagram for pdf_standardlabel:

Public Member Functions

 addSticker (&$pdf, $outputlangs, $param)
 Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0) More...
 
 Add_PDF_label (&$pdf, $textleft, $header, $footer, $outputlangs, $textright='', $photo='')
 Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0) More...
 
 write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='', $filename='tmp_address_sheet.pdf')
 Function to build PDF on disk, then output on HTTP strem. More...
 
- Public Member Functions inherited from CommonStickerGenerator
 __construct ($db)
 Constructor. More...
 
 write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='')
 Function to build PDF on disk, then output on HTTP strem. More...
 
 addSticker (&$pdf, $outputlangs, $param)
 Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0) More...
 
 Set_Char_Size (&$pdf, $pt)
 Methode qui permet de modifier la taille des caracteres Cela modiera aussi l'espace entre chaque ligne. More...
 
 _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...
 

Detailed Description

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

Definition at line 34 of file pdf_standardlabel.class.php.

Member Function Documentation

◆ Add_PDF_label()

pdf_standardlabel::Add_PDF_label ( $pdf,
  $textleft,
  $header,
  $footer,
  $outputlangs,
  $textright = '',
  $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
PDF$pdfPDF reference
string$textleftText left
string$headerHeader
string$footerFooter
Translate$outputlangsOutput langs
string$textrightText right
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 64 of file pdf_standardlabel.class.php.

◆ addSticker()

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

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

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

Definition at line 44 of file pdf_standardlabel.class.php.

◆ write_file()

pdf_standardlabel::write_file (   $arrayofrecords,
  $outputlangs,
  $srctemplatepath,
  $outputdir = '',
  $filename = 'tmp_address_sheet.pdf' 
)

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

Parameters
array$arrayofrecordsArray of record informations (array('textleft'=>,'textheader'=>, ..., 'id'=>,'photo'=>)
Translate$outputlangsLang object for output language
string$srctemplatepathFull path of source filename for generator using a template file
string$outputdirOutput directory for pdf file
string$filenameShort file name of PDF output file
Returns
int 1=OK, 0=KO

Definition at line 241 of file pdf_standardlabel.class.php.


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