dolibarr 21.0.0-alpha
mod_sn_free Class Reference
Inheritance diagram for mod_sn_free:
Collaboration diagram for mod_sn_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

Definition at line 34 of file mod_sn_free.php.

Member Function Documentation

◆ getExample()

mod_sn_free::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefBatch.

Definition at line 77 of file mod_sn_free.php.

References getNextValue().

◆ getNextValue()

mod_sn_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

Reimplemented from ModeleNumRefBatch.

Definition at line 96 of file mod_sn_free.php.

Referenced by getExample().

◆ info()

mod_sn_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 65 of file mod_sn_free.php.


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