CommonStickerGenerator Class Reference

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

Inheritance diagram for CommonStickerGenerator:

Collaboration diagram for CommonStickerGenerator:

Public Member Functions
	__construct ($db)
	Constructor.
	write_file ($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='', $filename='')
	Function to build PDF on disk, then output on HTTP stream.
	addSticker (&$pdf, $outputlangs, $param)
	Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
	Set_Char_Size (&$pdf, $pt)
	Method to modify the size of characters This will also modify the space between lines.
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.
	printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D')
	Print a rounded rectangle on the 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.

Protected Member Functions
	_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

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

Detailed Description

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

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

Constructor & Destructor Documentation

__construct()

CommonStickerGenerator::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonDocGenerator.

Reimplemented in pdf_standard_member.

Definition at line 125 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	$pdf	PDF reference
int	$x1	X1
int	$y1	Y1
int	$x2	X2
int	$y2	Y2
int	$epaisseur	Epaisseur
int	$taille	Size

Returns

void

@phan-suppress PhanPluginSuspiciousParamPosition

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

Referenced by pdf_standard_member\Add_PDF_card(), and pdf_standardlabel\Add_PDF_label().

_Get_Height_Chars()

CommonStickerGenerator::_Get_Height_Chars ( $pt )

protected

protected Give the height for a char size given.

Parameters

int

$pt

Point

Returns

int Height chars

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

Referenced by Set_Char_Size().

_Pointille()

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

protected

protected Print dot line

Parameters

TCPDF	$pdf	PDF reference
int	$x1	X1
int	$y1	Y1
int	$x2	X2
int	$y2	Y2
int	$epaisseur	Epaisseur
int	$nbPointilles	Nb pointilles

Returns

void

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

_Set_Format()

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

protected

protected Set format

Parameters

TCPDF	$pdf	PDF reference
	array{metric:string,name:string,code:string,marginLeft:float,marginTop:float,SpaceX:float,SpaceY:float,NX:int,NY:int,width:float,height:float,font-size:float}	$format Format

Returns

void

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

References convertMetric(), and Set_Char_Size().

Referenced by pdf_standard_member\write_file(), pdf_standardlabel\write_file(), and pdf_tcpdflabel\write_file().

addSticker()

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

abstract

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<string,mixed>	$param Associative array containing label content and optional parameters

Returns

void

Reimplemented in pdf_standard_member, pdf_standardlabel, and pdf_tcpdflabel.

convertMetric()

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

private

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

Parameters

float	$value	value
string	$src	from ('in' or 'mm')
string	$dest	to ('in' or 'mm')

Returns

float value value after conversion

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

Referenced by _Set_Format().

Set_Char_Size()

CommonStickerGenerator::Set_Char_Size	(	&	$pdf,
			$pt )

Method to modify the size of characters This will also modify the space between lines.

Parameters

TCPDF	$pdf	PDF reference
int	$pt	Point

Returns

void

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

References _Get_Height_Chars().

Referenced by _Set_Format().

write_file()

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

abstract

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

Parameters

	Adherent|array<array{textleft:string,textheader:string,textfooter:string,textright:string,id:string,photo:string}>	$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 output file

Returns

int<-1,1> 1=OK, <=0=KO

Reimplemented in pdf_standardlabel, and pdf_tcpdflabel.

---

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

• dolibarr_dev/htdocs/core/class/commonstickergenerator.class.php