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

Class to manage cheque receipts numbering rules Thyme. More...

+ Inheritance diagram for mod_chequereceipt_thyme:
+ Collaboration diagram for mod_chequereceipt_thyme:

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...
 
 chequereceipt_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefChequeReceipts
 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 cheque receipts numbering rules Thyme.

Definition at line 32 of file mod_chequereceipt_thyme.php.

Member Function Documentation

mod_chequereceipt_thyme::chequereceipt_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_chequereceipt_thyme.php.

References getNextValue().

mod_chequereceipt_thyme::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 93 of file mod_chequereceipt_thyme.php.

References getNextValue().

mod_chequereceipt_thyme::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 116 of file mod_chequereceipt_thyme.php.

References get_next_value().

Referenced by chequereceipt_get_num(), and getExample().

mod_chequereceipt_thyme::info ( )

Returns the description of the numbering model.

Returns
string Texte descripif

Definition at line 53 of file mod_chequereceipt_thyme.php.


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