dolibarr 21.0.0-alpha
mod_expensereport_sand Class Reference

Class to manage expense report numbering rules Sand. More...

Inheritance diagram for mod_expensereport_sand:
Collaboration diagram for mod_expensereport_sand:

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 expense report numbering rules Sand.

Definition at line 33 of file mod_expensereport_sand.php.

Member Function Documentation

◆ getExample()

mod_expensereport_sand::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefExpenseReport.

Definition at line 107 of file mod_expensereport_sand.php.

References getNextValue().

◆ getNextValue()

mod_expensereport_sand::getNextValue ( $object)

Return next free value.

Parameters
ExpenseReport$objectObject we need next value for
Returns
string|int<-1,0> Next value if OK, -1 or 0 if KO

Reimplemented from ModeleNumRefExpenseReport.

Definition at line 129 of file mod_expensereport_sand.php.

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

Referenced by getExample().

◆ info()

mod_expensereport_sand::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 65 of file mod_expensereport_sand.php.

References getDolGlobalString().


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