dolibarr  20.0.0-alpha
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
CommonStickerGenerator Class Reference

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

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='')
 Function to build PDF on disk, then output on HTTP stream. 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...
 
- 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...
 

Protected Member Functions

 _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...
 

Private Member Functions

 convertMetric ($value, $src, $dest)
 Convert units (in to mm, mm to in) $src and $dest must be 'in' or 'mm'. More...
 

Detailed Description

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

Definition at line 63 of file commonstickergenerator.class.php.

Constructor & Destructor Documentation

◆ __construct()

CommonStickerGenerator::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from CommonDocGenerator.

Reimplemented in pdf_standard, pdf_standard, pdf_standard, pdf_standard, pdf_standard, pdf_standard, and pdf_standard.

Definition at line 118 of file commonstickergenerator.class.php.

Member Function Documentation

◆ _Croix()

CommonStickerGenerator::_Croix ( $pdf,
  $x1 = 0,
  $y1 = 0,
  $x2 = 210,
  $y2 = 297,
  $epaisseur = 1,
  $taille = 4 
)
protected

protected Function realisant une croix aux 4 coins des cartes

Parameters
TCPDF$pdfPDF reference
int$x1X1
int$y1Y1
int$x2X2
int$y2Y2
int$epaisseurEpaisseur
int$tailleSize
Returns
void

@phan-suppress PhanPluginSuspiciousParamPosition

Definition at line 228 of file commonstickergenerator.class.php.

◆ _Get_Height_Chars()

CommonStickerGenerator::_Get_Height_Chars (   $pt)
protected

protected Give the height for a char size given.

Parameters
int$ptPoint
Returns
int Height chars

Definition at line 281 of file commonstickergenerator.class.php.

◆ _Pointille()

CommonStickerGenerator::_Pointille ( $pdf,
  $x1 = 0,
  $y1 = 0,
  $x2 = 210,
  $y2 = 297,
  $epaisseur = 1,
  $nbPointilles = 15 
)
protected

protected Print dot line

Parameters
TCPDF$pdfPDF reference
int$x1X1
int$y1Y1
int$x2X2
int$y2Y2
int$epaisseurEpaisseur
int$nbPointillesNb pointilles
Returns
void

Definition at line 179 of file commonstickergenerator.class.php.

◆ _Set_Format()

CommonStickerGenerator::_Set_Format ( $pdf,
  $format 
)
protected

protected Set format

Parameters
TCPDF$pdfPDF reference
array{metric:string,name:string,code:string,marginLeft:float,marginTip:float,SpaceX:float,SpaceY:float,NX:int,NY:int,width:float,height:float,font-size:float}$format Format
Returns
void

Definition at line 302 of file commonstickergenerator.class.php.

◆ addSticker()

CommonStickerGenerator::addSticker ( $pdf,
  $outputlangs,
  $param 
)
abstract

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 in pdf_tcpdflabel, pdf_standardlabel, and pdf_standard.

◆ convertMetric()

CommonStickerGenerator::convertMetric (   $value,
  $src,
  $dest 
)
private

Convert units (in to mm, mm to in) $src and $dest must be 'in' or 'mm'.

Parameters
int$valuevalue
string$srcfrom ('in' or 'mm')
string$destto ('in' or 'mm')
Returns
float value value after conversion

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

◆ Set_Char_Size()

CommonStickerGenerator::Set_Char_Size ( $pdf,
  $pt 
)

Methode qui permet de modifier la taille des caracteres Cela modiera aussi l'espace entre chaque ligne.

Parameters
TCPDF$pdfPDF reference
int$ptpoint
Returns
void

Definition at line 155 of file commonstickergenerator.class.php.

◆ write_file()

CommonStickerGenerator::write_file (   $arrayofrecords,
  $outputlangs,
  $srctemplatepath,
  $outputdir = '' 
)
abstract

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
Returns
int 1=OK, 0=KO

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