modTalerBarr
extends DolibarrModules
in package
Description and activation class for module TalerBarr
Table of Contents
Methods
- __construct() : mixed
- Constructor. Define names, constants, directories, boxes, permissions
- init() : mixed
- Function called when module is enabled.
- remove() : int<-1, 1>
- Function called when module is disabled.
- disableTalerClearingAccount() : int
- Mark the GNU Taler clearing account as closed and drop the tracking constant.
- disableTalerPaymentMethod() : int
- Disable the Taler Digital Cash payment method if present.
- enableTalerPaymentMethod() : int
- Ensure the Taler Digital Cash payment method exists and is active.
- ensureDefaultCustomer() : int
- Ensure a default customer exists for walk-in Taler sales.
- ensureTalerClearingAccount() : int
- Ensure the GNU Taler clearing bank account exists and stays open.
Methods
__construct()
Constructor. Define names, constants, directories, boxes, permissions
public
__construct(DoliDB $db) : mixed
Parameters
- $db : DoliDB
-
Database handler
init()
Function called when module is enabled.
public
init([string $options = '' ]) : mixed
The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. It also creates data directories
Parameters
- $options : string = ''
-
Options when enabling module ('', 'noboxes') @return int<-1,1> 1 if OK, <=0 if KO
remove()
Function called when module is disabled.
public
remove([string $options = '' ]) : int<-1, 1>
Remove from database constants, boxes and permissions from Dolibarr database. Data directories are not deleted
Parameters
- $options : string = ''
-
Options when enabling module ('', 'noboxes')
Return values
int<-1, 1> —1 if OK, <=0 if KO
disableTalerClearingAccount()
Mark the GNU Taler clearing account as closed and drop the tracking constant.
private
disableTalerClearingAccount() : int
Return values
int —1 if OK, <0 if error
disableTalerPaymentMethod()
Disable the Taler Digital Cash payment method if present.
private
disableTalerPaymentMethod() : int
Return values
int —1 if OK, <0 if error
enableTalerPaymentMethod()
Ensure the Taler Digital Cash payment method exists and is active.
private
enableTalerPaymentMethod() : int
Return values
int —1 if OK, <0 if error
ensureDefaultCustomer()
Ensure a default customer exists for walk-in Taler sales.
private
ensureDefaultCustomer() : int
Return values
int —1 if OK, <0 if error
ensureTalerClearingAccount()
Ensure the GNU Taler clearing bank account exists and stays open.
private
ensureTalerClearingAccount() : int
Return values
int —1 if OK, <0 if error