dolibarr 21.0.0-alpha
mod_partnership_advanced Class Reference

Class to manage the Advanced numbering rule for Partnership. More...

Inheritance diagram for mod_partnership_advanced:
Collaboration diagram for mod_partnership_advanced:

Public Member Functions

 info ($langs)
 Returns the description of the numbering model.
 
 getExample ()
 Return an example of numbering.
 
 getNextValue ($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 the Advanced numbering rule for Partnership.

Definition at line 35 of file mod_partnership_advanced.php.

Member Function Documentation

◆ getExample()

mod_partnership_advanced::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 100 of file mod_partnership_advanced.php.

References $object, and getNextValue().

◆ getNextValue()

mod_partnership_advanced::getNextValue ( $object)

Return next free value.

Parameters
Object$objectObject we need next value for
Returns
string|0 Next value if OK, 0 if KO

Definition at line 129 of file mod_partnership_advanced.php.

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

Referenced by getExample().

◆ info()

mod_partnership_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 60 of file mod_partnership_advanced.php.

References getDolGlobalString().


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