dolibarr 25.0.0-alpha
mod_inventory_leaf Class Reference

Class to manage the free numbering rule for Inventory (the reference is typed manually) More...

Inheritance diagram for mod_inventory_leaf:
Collaboration diagram for mod_inventory_leaf:

Public Member Functions

 info ($langs)
 Return description of numbering module.
 
 getExample ()
 Return an example of numbering.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getNextValue ($object)
 Return next free value: empty string, the user types the reference.
 
- 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.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage the free numbering rule for Inventory (the reference is typed manually)

Definition at line 29 of file mod_inventory_leaf.php.

Member Function Documentation

◆ canBeActivated()

mod_inventory_leaf::canBeActivated ( $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 86 of file mod_inventory_leaf.php.

◆ getExample()

mod_inventory_leaf::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefInventory.

Definition at line 72 of file mod_inventory_leaf.php.

◆ getNextValue()

mod_inventory_leaf::getNextValue ( $object)

Return next free value: empty string, the user types the reference.

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 97 of file mod_inventory_leaf.php.

◆ info()

mod_inventory_leaf::info ( $langs)

Return description of numbering module.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 59 of file mod_inventory_leaf.php.


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