dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_payment_ant Class Reference

Class to manage customer payment numbering rules Ant. More...

Inheritance diagram for mod_payment_ant:
Inheritance graph
[legend]
Collaboration diagram for mod_payment_ant:
Collaboration graph
[legend]

Public Member Functions

 info ($langs)
 Returns the description of the numbering model. More...
 
 getExample ()
 Return an example of numbering. More...
 
 getNextValue ($objsoc, $object)
 Return next free value. More...
 
 commande_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name. More...
 
 getName ($langs)
 Return model name. More...
 
 isEnabled ()
 Return if a module can be used or not. More...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage customer payment numbering rules Ant.

Definition at line 31 of file mod_payment_ant.php.

Member Function Documentation

◆ commande_get_num()

mod_payment_ant::commande_get_num (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
string$objforrefObject for number to search
Returns
string|0 Next free value, 0 if KO

Definition at line 153 of file mod_payment_ant.php.

◆ getExample()

mod_payment_ant::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 103 of file mod_payment_ant.php.

◆ getNextValue()

mod_payment_ant::getNextValue (   $objsoc,
  $object 
)

Return next free value.

Parameters
Societe$objsocObject thirdparty
Object$objectObject we need next value for
Returns
string|0 Value if OK, 0 if KO

Definition at line 125 of file mod_payment_ant.php.

◆ info()

mod_payment_ant::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 63 of file mod_payment_ant.php.


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