dolibarr 21.0.0-alpha
ModeleNumRefPayments Class Reference

Payment numbering references mother class. More...

Inheritance diagram for ModeleNumRefPayments:
Collaboration diagram for ModeleNumRefPayments:

Public Member Functions

 getNextValue ($objsoc, $object)
 Return next free value.
 
 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

Payment numbering references mother class.

Definition at line 25 of file modules_payment.php.

Member Function Documentation

◆ getExample()

ModeleNumRefPayments::getExample ( )
abstract

Return an example of numbering.

Returns
string Example

Reimplemented in mod_payment_ant, and mod_payment_cicada.

◆ getNextValue()

ModeleNumRefPayments::getNextValue ( $objsoc,
$object )
abstract

Return next free value.

Parameters
Societe$objsocObject thirdparty
?Paiement$objectObject we need next value for
Returns
string|int<-1,0> Value if OK, <=0 if KO

Reimplemented in mod_payment_ant, and mod_payment_cicada.


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