dolReceiptPrinter Class Reference

Class to manage Receipt Printers. More...

Inheritance diagram for dolReceiptPrinter:

Collaboration diagram for dolReceiptPrinter:

Public Member Functions
	__construct ($db)
	Constructor.
	listPrinters ()
	List printers into the array ->listprinters.
	listPrintersTemplates ()
	List printers templates.
	selectTypePrinter ($selected='', $htmlname='printertypeid')
	Form to Select type printer.
	selectProfilePrinter ($selected='', $htmlname='printerprofileid')
	Form to Select Profile printer.
	addPrinter ($name, $type, $profile, $parameter)
	Function to Add a printer in db.
	updatePrinter ($name, $type, $profile, $parameter, $printerid)
	Function to Update a printer in db.
	deletePrinter ($printerid)
	Function to Delete a printer from db.
	addTemplate ($name, $template)
	Function to add a printer template in db.
	deleteTemplate ($templateid)
	Function to delete a printer template in db.
	updateTemplate ($name, $template, $templateid)
	Function to Update a printer template in db.
	sendTestToPrinter ($printerid, $addimgandbarcode=0)
	Function to Send Test page to Printer.
	sendToPrinter ($object, $templateid, $printerid)
	Function to Print Receipt Ticket.
	loadTemplate ($templateid)
	Function to load Template into $this->template.
	initPrinter ($printerid)
	Function Init Printer into $this->printer.

Detailed Description

Class to manage Receipt Printers.

Definition at line 120 of file dolreceiptprinter.class.php.

Constructor & Destructor Documentation

__construct()

dolReceiptPrinter::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

database

Definition at line 183 of file dolreceiptprinter.class.php.

Member Function Documentation

addPrinter()

dolReceiptPrinter::addPrinter	(		$name,
			$type,
			$profile,
			$parameter )

Function to Add a printer in db.

Parameters

string	$name	Printer name
int	$type	Printer type
int	$profile	Printer profile
string	$parameter	Printer parameter

Returns

int 0 if OK; >0 if KO

Definition at line 436 of file dolreceiptprinter.class.php.

addTemplate()

dolReceiptPrinter::addTemplate	(		$name,
			$template )

Function to add a printer template in db.

Parameters

string	$name	Template name
int	$template	Template

Returns

int 0 if OK; >0 if KO

Definition at line 507 of file dolreceiptprinter.class.php.

deletePrinter()

dolReceiptPrinter::deletePrinter

(

$printerid

)

Function to Delete a printer from db.

Parameters

int

$printerid

Printer id

Returns

int 0 if OK; >0 if KO

Definition at line 486 of file dolreceiptprinter.class.php.

deleteTemplate()

dolReceiptPrinter::deleteTemplate

(

$templateid

)

Function to delete a printer template in db.

Parameters

int

$templateid

Template ID

Returns

int 0 if OK; >0 if KO

Definition at line 528 of file dolreceiptprinter.class.php.

initPrinter()

dolReceiptPrinter::initPrinter

(

$printerid

)

Function Init Printer into $this->printer.

Parameters

int

$printerid

Printer id

Returns

void|int 0 if OK; >0 if KO

Definition at line 1008 of file dolreceiptprinter.class.php.

References dol_sanitizePathName(), and getDolGlobalString().

Referenced by sendTestToPrinter(), and sendToPrinter().

listPrinters()

dolReceiptPrinter::listPrinters

(

)

List printers into the array ->listprinters.

Returns

int 0 if OK; >0 if KO

Definition at line 273 of file dolreceiptprinter.class.php.

listPrintersTemplates()

dolReceiptPrinter::listPrintersTemplates

(

)

List printers templates.

Returns

int 0 if OK; >0 if KO

Definition at line 347 of file dolreceiptprinter.class.php.

loadTemplate()

dolReceiptPrinter::loadTemplate

(

$templateid

)

Function to load Template into $this->template.

Parameters

int

$templateid

Template id

Returns

int 0 if OK; >0 if KO

Definition at line 975 of file dolreceiptprinter.class.php.

Referenced by sendToPrinter().

selectProfilePrinter()

dolReceiptPrinter::selectProfilePrinter	(		$selected = '',
			$htmlname = 'printerprofileid' )

Form to Select Profile printer.

Parameters

string	$selected	Id printer profile pre-selected
string	$htmlname	select html name

Returns

int 0 if OK; >0 if KO

Definition at line 410 of file dolreceiptprinter.class.php.

References Form\selectarray().

selectTypePrinter()

dolReceiptPrinter::selectTypePrinter	(		$selected = '',
			$htmlname = 'printertypeid' )

Form to Select type printer.

Parameters

string	$selected	Id printer type pre-selected
string	$htmlname	select html name

Returns

int 0 if OK; >0 if KO

Definition at line 385 of file dolreceiptprinter.class.php.

References Form\selectarray().

sendTestToPrinter()

dolReceiptPrinter::sendTestToPrinter	(		$printerid,
			$addimgandbarcode = 0 )

Function to Send Test page to Printer.

Parameters

int	$printerid	Printer id
int	$addimgandbarcode	Add image and barcode into the test

Returns

int 0 if OK; >0 if KO

Definition at line 576 of file dolreceiptprinter.class.php.

References dol_syslog(), initPrinter(), and setEventMessages().

sendToPrinter()

dolReceiptPrinter::sendToPrinter	(		$object,
			$templateid,
			$printerid )

Function to Print Receipt Ticket.

Parameters

Facture | Commande	$object	Order or invoice object
int	$templateid	Template id
int	$printerid	Printer id

Returns

int 0 if OK; >0 if KO

Definition at line 623 of file dolreceiptprinter.class.php.

References dol_now(), dol_print_date(), dol_syslog(), getDolGlobalInt(), getDolGlobalString(), initPrinter(), loadTemplate(), price(), and setEventMessages().

updatePrinter()

dolReceiptPrinter::updatePrinter	(		$name,
			$type,
			$profile,
			$parameter,
			$printerid )

Function to Update a printer in db.

Parameters

string	$name	Printer name
int	$type	Printer type
int	$profile	Printer profile
string	$parameter	Printer parameter
int	$printerid	Printer id

Returns

int 0 if OK; >0 if KO

Definition at line 461 of file dolreceiptprinter.class.php.

updateTemplate()

dolReceiptPrinter::updateTemplate	(		$name,
			$template,
			$templateid )

Function to Update a printer template in db.

Parameters

string	$name	Template name
int	$template	Template
int	$templateid	Template id

Returns

int 0 if OK; >0 if KO

Definition at line 551 of file dolreceiptprinter.class.php.

---

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

• dolibarr_19.0/htdocs/core/class/dolreceiptprinter.class.php