mod_bookkeeping_helium Class Reference

Class to manage Bookkeeping numbering rules Helium, configurable numbering model. More...

Inheritance diagram for mod_bookkeeping_helium:

Collaboration diagram for mod_bookkeeping_helium:

Public Member Functions
	info ($langs)
	Returns the description of the numbering model.
	getExample ()
	Return an example of numbering.
	getNextValue (BookKeeping $object)
	Return next free value.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name.
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage Bookkeeping numbering rules Helium, configurable numbering model.

Definition at line 37 of file mod_bookkeeping_helium.php.

Member Function Documentation

getExample()

mod_bookkeeping_helium::getExample

(

)

Return an example of numbering.

Returns

string|int<0,0> Example

Reimplemented from ModeleNumRefBookkeeping.

Definition at line 113 of file mod_bookkeeping_helium.php.

References $db, and getNextValue().

getNextValue()

mod_bookkeeping_helium::getNextValue

(

BookKeeping

$object

)

Return next free value.

Parameters

BookKeeping

$object

Object we need next value for

Returns

string|int<-1,0> Value if OK, -1 if KO

Reimplemented from ModeleNumRefBookkeeping.

Definition at line 137 of file mod_bookkeeping_helium.php.

References $conf, $db, $object, get_next_value(), and getDolGlobalString().

Referenced by getExample().

info()

mod_bookkeeping_helium::info

(

$langs

)

Returns the description of the numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 67 of file mod_bookkeeping_helium.php.

References $db, getDolGlobalString(), and name.

---

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

• dolibarr_dev/htdocs/core/modules/accountancy/mod_bookkeeping_helium.php