dolibarr  13.0.2
Public Member Functions | List of all members
mod_supplier_payment_bronan Class Reference

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

+ Inheritance diagram for mod_supplier_payment_bronan:
+ Collaboration diagram for mod_supplier_payment_bronan:

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ()
 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 ModeleNumRefSupplierPayments
 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 ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. 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_supplier_payment_bronan.php.

Member Function Documentation

mod_supplier_payment_bronan::canBeActivated ( )

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

Returns
boolean false if conflict, true if ok

Definition at line 87 of file mod_supplier_payment_bronan.php.

References $resql.

mod_supplier_payment_bronan::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 75 of file mod_supplier_payment_bronan.php.

mod_supplier_payment_bronan::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 122 of file mod_supplier_payment_bronan.php.

References $resql, and dol_syslog().

Referenced by payment_get_num().

mod_supplier_payment_bronan::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 63 of file mod_supplier_payment_bronan.php.

mod_supplier_payment_bronan::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 164 of file mod_supplier_payment_bronan.php.

References getNextValue().


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