dolibarr 21.0.0-alpha
mod_sn_advanced Class Reference

Class to manage Batch numbering rules advanced. More...

Inheritance diagram for mod_sn_advanced:
Collaboration diagram for mod_sn_advanced:

Public Member Functions

 info ($langs)
 Returns the description of the numbering model.
 
 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 to manage Batch numbering rules advanced.

Definition at line 37 of file mod_sn_advanced.php.

Member Function Documentation

◆ getExample()

mod_sn_advanced::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefBatch.

Definition at line 116 of file mod_sn_advanced.php.

References getNextValue().

◆ getNextValue()

mod_sn_advanced::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 140 of file mod_sn_advanced.php.

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

Referenced by getExample().

◆ info()

mod_sn_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 62 of file mod_sn_advanced.php.

References getDolGlobalString(), img_picto(), and newToken().


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