dolibarr 21.0.0-alpha
mod_bom_advanced Class Reference

Class to manage customer Bom numbering rules advanced. More...

Inheritance diagram for mod_bom_advanced:
Collaboration diagram for mod_bom_advanced:

Public Member Functions

 info ($langs)
 Returns the description of the numbering model.
 
 getExample ()
 Return an example of numbering.
 
 getNextValue ($objprod, $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 customer Bom numbering rules advanced.

Definition at line 36 of file mod_bom_advanced.php.

Member Function Documentation

◆ getExample()

mod_bom_advanced::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefBoms.

Definition at line 102 of file mod_bom_advanced.php.

References getNextValue().

◆ getNextValue()

mod_bom_advanced::getNextValue ( $objprod,
$object )

Return next free value.

Parameters
Product$objprodObject product
?Bom$objectObject we need next value for
Returns
string|int<-1,0> Next value if OK, 0 if KO

Reimplemented from ModeleNumRefBoms.

Definition at line 127 of file mod_bom_advanced.php.

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

Referenced by getExample().

◆ info()

mod_bom_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 61 of file mod_bom_advanced.php.

References getDolGlobalString().


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