dolibarr 21.0.0-alpha
ModeleNumRefFactures Class Reference

Parent class of invoice reference numbering templates. More...

Inheritance diagram for ModeleNumRefFactures:
Collaboration diagram for ModeleNumRefFactures:

Public Member Functions

 getNextValue ($objsoc, $invoice, $mode='next')
 Return next value not used or last value used.
 
 getExample ()
 Return an example of numbering.
 
- 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.
 
 info ($langs)
 Returns the default description of the numbering template.
 
 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

Parent class of invoice reference numbering templates.

Definition at line 269 of file modules_facture.php.

Member Function Documentation

◆ getExample()

ModeleNumRefFactures::getExample ( )
abstract

Return an example of numbering.

Returns
string Example

Reimplemented in mod_facture_mars, mod_facture_mercure, and mod_facture_terre.

◆ getNextValue()

ModeleNumRefFactures::getNextValue ( $objsoc,
$invoice,
$mode = 'next' )
abstract

Return next value not used or last value used.

Parameters
Societe$objsocObject third party
?Facture$invoiceObject invoice
string$mode'next' for next value or 'last' for last value
Returns
string|int<-1,0> Value if OK, <=0 if KO

Reimplemented in mod_facture_mars, mod_facture_mercure, and mod_facture_terre.


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