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 stream. 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 stream. More... | |
| Set_Char_Size (&$pdf, $pt) | |
| Methode qui permet de modifier la taille des caracteres Cela modiera aussi l'espace entre chaque ligne. 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... | |
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 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
-
TCPDF $pdf PDF reference string $textleft Text left string $header Header string $footer Footer Translate $outputlangs Output langs string $textright Text right string $photo Photo (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
-
TCPDF $pdf PDF reference Translate $outputlangs Output langs array $param Associative array containing label content and optional parameters
- Returns
- void
Reimplemented from CommonStickerGenerator.
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 stream.
- Parameters
-
array $arrayofrecords Array of record information (array('textleft'=>,'textheader'=>, ..., 'id'=>,'photo'=>) Translate $outputlangs Lang object for output language string $srctemplatepath Full path of source filename for generator using a template file string $outputdir Output directory for pdf file string $filename Short file name of PDF output file
- Returns
- int 1=OK, 0=KO
Definition at line 237 of file pdf_standardlabel.class.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php