dolibarr 20.0.0
pdf_tcpdflabel Class Reference

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

Inheritance diagram for pdf_tcpdflabel:
Collaboration diagram for pdf_tcpdflabel:

Public Member Functions

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

Private Member Functions

 writeBarcode (&$pdf, $code, $encoding, $is2d, $x, $y, $w, $h)
 write barcode to pdf
 

Additional Inherited Members

- Protected Member Functions inherited from CommonStickerGenerator
 _Pointille (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $nbPointilles=15)
 protected Print dot line
 
 _Croix (&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $taille=4)
 protected Function realisant une croix aux 4 coins des cartes
 
 _Get_Height_Chars ($pt)
 protected Give the height for a char size given.
 
 _Set_Format (&$pdf, $format)
 protected Set format
 

Detailed Description

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

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

Member Function Documentation

◆ addSticker()

pdf_tcpdflabel::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 99 of file pdf_tcpdflabel.class.php.

References writeBarcode().

Referenced by write_file().

◆ write_file()

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

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

Parameters
array$arrayofrecordsArray 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
string$outputdirOutput directory for pdf file
string$filenameShort file name of PDF output file
Returns
int 1=OK, 0=KO

Definition at line 260 of file pdf_tcpdflabel.class.php.

References CommonStickerGenerator\_Set_Format(), addSticker(), dol_mkdir(), dol_print_error(), dolChmod(), getDolGlobalString(), pdf_getInstance(), pdf_getPDFFont(), and type.

◆ writeBarcode()

pdf_tcpdflabel::writeBarcode ( & $pdf,
$code,
$encoding,
$is2d,
$x,
$y,
$w,
$h )
private

write barcode to pdf

Parameters
TCPDF$pdfPDF reference
string$codecode to print
string$encodingtype of barcode
boolean$is2dtrue if 2d barcode
int$xx position in user units
int$yy position in user units
int$wwidth in user units
int$hheight in user units
Returns
void

Definition at line 82 of file pdf_tcpdflabel.class.php.

Referenced by addSticker().


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