dolibarr 20.0.0
mod_chequereceipt_mint Class Reference

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

Inheritance diagram for mod_chequereceipt_mint:
Collaboration diagram for mod_chequereceipt_mint:

Public Member Functions

 info ($langs)
 Return description of numbering module.
 
 getExample ()
 Return an example of numbering.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getNextValue ($objsoc, $object)
 Return next free value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name.
 
 getName ($langs)
 Return model name.
 
 isEnabled ()
 Return if a module can be used or not.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage cheque receipts numbering rules Mint.

Definition at line 32 of file mod_chequereceipt_mint.php.

Member Function Documentation

◆ canBeActivated()

mod_chequereceipt_mint::canBeActivated ( $object)

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

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

Reimplemented from CommonNumRefGenerator.

Definition at line 81 of file mod_chequereceipt_mint.php.

◆ getExample()

mod_chequereceipt_mint::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 68 of file mod_chequereceipt_mint.php.

◆ getNextValue()

mod_chequereceipt_mint::getNextValue ( $objsoc,
$object )

Return next free value.

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

Definition at line 118 of file mod_chequereceipt_mint.php.

References $object, dol_print_date(), and dol_syslog().

◆ info()

mod_chequereceipt_mint::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 56 of file mod_chequereceipt_mint.php.


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