dolibarr  7.0.0-beta
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:
+ Collaboration diagram for mod_payment_cicada:

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Renvoi un exemple de numerotation. More...
 
 canBeActivated ()
 Test si les numeros deje en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner. More...
 
 getNextValue ($objsoc, $object)
 Return next free value. More...
 
 payment_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...
 
 info ()
 Return the default description of numbering module. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ()
 Test if the existing numbers in the database do not cause conflicts that would prevent this numbering run. More...
 
 getNextValue ($objsoc, $object)
 Returns the next value. More...
 
 getVersion ()
 Returns the module numbering version. More...
 

Detailed Description

Class to manage customer payment numbering rules Cicada.

Definition at line 30 of file mod_payment_cicada.php.

Member Function Documentation

mod_payment_cicada::canBeActivated ( )

Test si les numeros deje en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner.

Returns
boolean false si conflit, true si ok

Definition at line 67 of file mod_payment_cicada.php.

References $resql.

mod_payment_cicada::getExample ( )

Renvoi un exemple de numerotation.

Returns
string Example

Definition at line 55 of file mod_payment_cicada.php.

mod_payment_cicada::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

Definition at line 102 of file mod_payment_cicada.php.

References $resql, and dol_syslog().

Referenced by payment_get_num().

mod_payment_cicada::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 43 of file mod_payment_cicada.php.

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 Next free value

Definition at line 145 of file mod_payment_cicada.php.

References getNextValue().


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