PrintingDriver Class Reference

Parent class of emailing target selectors modules. More...

Inheritance diagram for PrintingDriver:

Public Member Functions
	__construct ($db)
	Constructor.
	getDesc ()
	Return description of Printing Module.
	listAvailablePrinters ()
	Return list of available printers.
	getlistAvailablePrinters ()
	Return list of available printers.
	printFile ($file, $module, $subdir='')
	Print selected file.
	listJobs ($module=null)
	List jobs print.

Static Public Member Functions
static	listDrivers ($db, $maxfilenamelength=0)
	Return list of printing driver.

Detailed Description

Parent class of emailing target selectors modules.

Definition at line 33 of file modules_printing.php.

Constructor & Destructor Documentation

__construct()

PrintingDriver::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in printing_printgcp, and printing_printipp.

Definition at line 71 of file modules_printing.php.

Member Function Documentation

getDesc()

PrintingDriver::getDesc

(

)

Return description of Printing Module.

Returns

string Return translation of key PrintingModuleDescXXX where XXX is module name, or $this->desc if not exists

Definition at line 113 of file modules_printing.php.

getlistAvailablePrinters()

PrintingDriver::getlistAvailablePrinters

(

)

Return list of available printers.

Returns

array<int|string,string|array<string|int,string>> list of printers

Reimplemented in printing_printgcp, and printing_printipp.

Definition at line 143 of file modules_printing.php.

References dol_syslog().

listAvailablePrinters()

PrintingDriver::listAvailablePrinters

(

)

Return list of available printers.

Returns

int 0 if OK, >0 if KO

Reimplemented in printing_printgcp, and printing_printipp.

Definition at line 130 of file modules_printing.php.

References dol_syslog().

listDrivers()

static PrintingDriver::listDrivers ( $db, $maxfilenamelength = 0 )

static

Return list of printing driver.

Parameters

DoliDB	$db	Database handler
int	$maxfilenamelength	Max length of value to show

Returns

array<string,string> List of drivers

Definition at line 83 of file modules_printing.php.

References $conf, dol_buildpath(), and dol_dir_list().

listJobs()

PrintingDriver::listJobs

(

$module = null

)

List jobs print.

Parameters

?string

$module

module

Returns

int 0 if OK, >0 if KO

Reimplemented in printing_printgcp, and printing_printipp.

Definition at line 174 of file modules_printing.php.

References dol_syslog().

printFile()

PrintingDriver::printFile	(		$file,
			$module,
			$subdir = '' )

Print selected file.

Parameters

string	$file	file
string	$module	module
string	$subdir	subdir for file

Returns

int 0 if OK, >0 if KO

Reimplemented in printing_printgcp, and printing_printipp.

Definition at line 159 of file modules_printing.php.

References dol_syslog().

---

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

• dolibarr_21.0/htdocs/core/modules/printing/modules_printing.php