dolibarr  17.0.0
Public Member Functions | List of all members
dolReceiptPrinter Class Reference

Class to manage Receipt Printers. More...

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

Public Member Functions

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

Detailed Description

Class to manage Receipt Printers.

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

Constructor & Destructor Documentation

◆ __construct()

dolReceiptPrinter::__construct (   $db)

Constructor.

Parameters
DoliDB$dbdatabase

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

References db.

Member Function Documentation

◆ addPrinter()

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

Function to Add a printer in db.

Parameters
string$namePrinter name
int$typePrinter type
int$profilePrinter profile
string$parameterPrinter parameter
Returns
int 0 if OK; >0 if KO

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

◆ addTemplate()

dolReceiptPrinter::addTemplate (   $name,
  $template 
)

Function to add a printer template in db.

Parameters
string$nameTemplate name
int$templateTemplate
Returns
int 0 if OK; >0 if KO

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

◆ deletePrinter()

dolReceiptPrinter::deletePrinter (   $printerid)

Function to Delete a printer from db.

Parameters
int$printeridPrinter id
Returns
int 0 if OK; >0 if KO

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

◆ deleteTemplate()

dolReceiptPrinter::deleteTemplate (   $templateid)

Function to delete a printer template in db.

Parameters
int$templateidTemplate ID
Returns
int 0 if OK; >0 if KO

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

◆ initPrinter()

dolReceiptPrinter::initPrinter (   $printerid)

Function Init Printer.

Parameters
int$printeridPrinter id
Returns
int 0 if OK; >0 if KO

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

◆ listPrinters()

dolReceiptPrinter::listPrinters ( )

list printers

Returns
int 0 if OK; >0 if KO

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

◆ listPrintersTemplates()

dolReceiptPrinter::listPrintersTemplates ( )

List printers templates.

Returns
int 0 if OK; >0 if KO

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

◆ loadTemplate()

dolReceiptPrinter::loadTemplate (   $templateid)

Function to load Template.

Parameters
int$templateidTemplate id
Returns
int 0 if OK; >0 if KO

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

◆ selectProfilePrinter()

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

Form to Select Profile printer.

Parameters
string$selectedId printer profile pre-selected
string$htmlnameselect html name
Returns
int 0 if OK; >0 if KO

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

◆ selectTypePrinter()

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

Form to Select type printer.

Parameters
string$selectedId printer type pre-selected
string$htmlnameselect html name
Returns
int 0 if OK; >0 if KO

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

◆ sendTestToPrinter()

dolReceiptPrinter::sendTestToPrinter (   $printerid)

Function to Send Test page to Printer.

Parameters
int$printeridPrinter id
Returns
int 0 if OK; >0 if KO

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

◆ sendToPrinter()

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

Function to Print Receipt Ticket.

Parameters
Facture | Commande$objectOrder or invoice object
int$templateidTemplate id
int$printeridPrinter id
Returns
int 0 if OK; >0 if KO

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

◆ updatePrinter()

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

Function to Update a printer in db.

Parameters
string$namePrinter name
int$typePrinter type
int$profilePrinter profile
string$parameterPrinter parameter
int$printeridPrinter id
Returns
int 0 if OK; >0 if KO

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

◆ updateTemplate()

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

Function to Update a printer template in db.

Parameters
string$nameTemplate name
int$templateTemplate
int$templateidTemplate id
Returns
int 0 if OK; >0 if KO

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


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