dolibarr 19.0.4
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 ($langs)
 Returns the description of the numbering model.
 
 getExample ()
 Return an example of numbering.
 
 getNextValue ($objsoc, $object)
 Return next free value.
 
 chequereceipt_get_num ($objsoc, $objforref)
 Return next free value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name TODO Replace with getName()
 
 getName ($langs)
 Return model name.
 
 isEnabled ()
 Return if a module can be used or not.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage cheque receipts numbering rules Thyme.

Definition at line 32 of file mod_chequereceipt_thyme.php.

Member Function Documentation

◆ chequereceipt_get_num()

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

References getNextValue().

◆ getExample()

mod_chequereceipt_thyme::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 94 of file mod_chequereceipt_thyme.php.

References getNextValue().

◆ getNextValue()

mod_chequereceipt_thyme::getNextValue ( $objsoc,
$object )

Return next free value.

Parameters
Societe$objsocObject thirdparty
RemiseCheque$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 dol_now(), and get_next_value().

Referenced by chequereceipt_get_num(), and getExample().

◆ info()

mod_chequereceipt_thyme::info ( $langs)

Returns the description of the numbering model.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 54 of file mod_chequereceipt_thyme.php.

References getDolGlobalString().


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