dolibarr 19.0.3
mod_reception_beryl Class Reference

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

Inheritance diagram for mod_reception_beryl:
Collaboration diagram for mod_reception_beryl:

Public Member Functions

 info ($langs)
 Return default description of numbering model.
 
 getExample ()
 Return numbering example.
 
 canBeActivated ($object)
 Test if existing numbers make problems with numbering.
 
 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.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage reception numbering rules Beryl.

Definition at line 29 of file mod_reception_beryl.php.

Member Function Documentation

◆ canBeActivated()

mod_reception_beryl::canBeActivated ( $object)

Test if existing numbers make problems with numbering.

Parameters
Object$objectObject we need next value for
Returns
boolean false if KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 67 of file mod_reception_beryl.php.

◆ getExample()

mod_reception_beryl::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 55 of file mod_reception_beryl.php.

◆ getNextValue()

mod_reception_beryl::getNextValue ( $objsoc,
$reception )

Return next value.

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

Definition at line 104 of file mod_reception_beryl.php.

References dol_print_date(), and dol_syslog().

Referenced by reception_get_num().

◆ info()

mod_reception_beryl::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_beryl.php.

◆ reception_get_num()

mod_reception_beryl::reception_get_num ( $objsoc,
$objforref )

Return next free value.

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

Definition at line 148 of file mod_reception_beryl.php.

References getNextValue().


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