dolibarr 21.0.0-alpha
mod_lot_free Class Reference

Class allowing lot_free management of batch numbers. More...

Inheritance diagram for mod_lot_free:
Collaboration diagram for mod_lot_free:

Public Member Functions

 __construct ()
 Constructor.
 
 info ($langs)
 Return description of module.
 
 getExample ()
 Return an example of numbering.
 
 getNextValue ($objsoc, $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 allowing lot_free management of batch numbers.

Definition at line 34 of file mod_lot_free.php.

Member Function Documentation

◆ getExample()

mod_lot_free::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefBatch.

Definition at line 78 of file mod_lot_free.php.

References getNextValue().

◆ getNextValue()

mod_lot_free::getNextValue ( $objsoc,
$object )

Return next free value.

Parameters
?Societe$objsocObject thirdparty
?Productlot$objectObject we need next value for
Returns
string|int<-1,0> Value if OK, <=0 if KO

Reimplemented from ModeleNumRefBatch.

Definition at line 90 of file mod_lot_free.php.

Referenced by getExample().

◆ info()

mod_lot_free::info ( $langs)

Return description of module.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 66 of file mod_lot_free.php.


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