dolibarr  20.0.0-alpha
Public Member Functions | List of all members
mod_payment_cicada Class Reference

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

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

Public Member Functions

 info ($langs)
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getNextValue ($objsoc, $object)
 Return next free value. More...
 
 payment_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...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage customer payment numbering rules Cicada.

Definition at line 31 of file mod_payment_cicada.php.

Member Function Documentation

◆ canBeActivated()

mod_payment_cicada::canBeActivated (   $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
Object$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 90 of file mod_payment_cicada.php.

◆ getExample()

mod_payment_cicada::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 77 of file mod_payment_cicada.php.

◆ getNextValue()

mod_payment_cicada::getNextValue (   $objsoc,
  $object 
)

Return next free value.

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

Definition at line 127 of file mod_payment_cicada.php.

◆ info()

mod_payment_cicada::info (   $langs)

Return description of numbering module.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 65 of file mod_payment_cicada.php.

◆ payment_get_num()

mod_payment_cicada::payment_get_num (   $objsoc,
  $objforref 
)

Return next free value.

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

Definition at line 174 of file mod_payment_cicada.php.


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