dolibarr 19.0.3
mod_reception_moonstone Class Reference

Class to manage reception numbering rules Moonstone. More...

Inheritance diagram for mod_reception_moonstone:
Collaboration diagram for mod_reception_moonstone:

Public Member Functions

 info ($langs)
 Return default description of numbering model.
 
 getExample ()
 Return numbering example.
 
 getNextValue ($objsoc, $reception)
 Return next value.
 
 reception_get_num ($objsoc, $objforref)
 Return next free value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name TODO Replace with getName()
 
 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 reception numbering rules Moonstone.

Definition at line 31 of file mod_reception_moonstone.php.

Member Function Documentation

◆ getExample()

mod_reception_moonstone::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 79 of file mod_reception_moonstone.php.

References getNextValue().

◆ getNextValue()

mod_reception_moonstone::getNextValue ( $objsoc,
$reception )

Return next value.

Parameters
Societe$objsocThird party object
Object | null$receptionReception object
Returns
string Value if OK, 0 if KO

Definition at line 104 of file mod_reception_moonstone.php.

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

Referenced by getExample(), and reception_get_num().

◆ info()

mod_reception_moonstone::info ( $langs)

Return default description of numbering model.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 43 of file mod_reception_moonstone.php.

References getDolGlobalString().

◆ reception_get_num()

mod_reception_moonstone::reception_get_num ( $objsoc,
$objforref )

Return next free value.

Parameters
Societe$objsocThird party object
Object$objforrefReception object
Returns
string Next free value

Definition at line 136 of file mod_reception_moonstone.php.

References getNextValue().


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