dolibarr 25.0.0-alpha
mod_inventory_advanced Class Reference

Class to manage the mask based numbering rule for Inventory. More...

Inheritance diagram for mod_inventory_advanced:
Collaboration diagram for mod_inventory_advanced:

Public Member Functions

 info ($langs)
 Returns the description of the numbering model.
 
 getExample ()
 Return an example of numbering.
 
 getNextValue ($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 the mask based numbering rule for Inventory.

Definition at line 29 of file mod_inventory_advanced.php.

Member Function Documentation

◆ getExample()

mod_inventory_advanced::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefInventory.

Definition at line 104 of file mod_inventory_advanced.php.

References $conf, $db, $mysoc, $object, and getNextValue().

◆ getNextValue()

mod_inventory_advanced::getNextValue ( $object)

Return next free value.

Parameters
Inventory$objectObject we need next value for
Returns
string|int<-1,0> Value if OK, 0 if KO

Reimplemented from ModeleNumRefInventory.

Definition at line 126 of file mod_inventory_advanced.php.

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

Referenced by getExample().

◆ info()

mod_inventory_advanced::info ( $langs)

Returns the description of the numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 59 of file mod_inventory_advanced.php.

References $db, getDolGlobalString(), and name.


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