dolibarr  19.0.0-dev
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 ()
 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 ModeleNumRefPayments
 isEnabled ()
 Return if a module can be used or not. More...
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Returns the module numbering version. 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 Next free value

Definition at line 152 of file mod_payment_ant.php.

◆ getExample()

mod_payment_ant::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefPayments.

Definition at line 102 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 Value if KO, <0 if KO

Reimplemented from ModeleNumRefPayments.

Definition at line 124 of file mod_payment_ant.php.

◆ info()

mod_payment_ant::info ( )

Returns the description of the numbering model.

Returns
string Descriptive text

Reimplemented from ModeleNumRefPayments.

Definition at line 62 of file mod_payment_ant.php.


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