dolibarr  17.0.3
Public Member Functions | List of all members
mod_chequereceipt_mint Class Reference

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

Inheritance diagram for mod_chequereceipt_mint:
Inheritance graph
[legend]
Collaboration diagram for mod_chequereceipt_mint:
Collaboration graph
[legend]

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...
 
 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...
 
 getVersion ()
 Returns the module numbering version. More...
 

Detailed Description

Class to manage cheque receipts numbering rules Mint.

Definition at line 30 of file mod_chequereceipt_mint.php.

Member Function Documentation

◆ canBeActivated()

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

Reimplemented from ModeleNumRefChequeReceipts.

Definition at line 77 of file mod_chequereceipt_mint.php.

◆ chequereceipt_get_num()

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

◆ getExample()

mod_chequereceipt_mint::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefChequeReceipts.

Definition at line 65 of file mod_chequereceipt_mint.php.

◆ getNextValue()

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

Reimplemented from ModeleNumRefChequeReceipts.

Definition at line 114 of file mod_chequereceipt_mint.php.

◆ info()

mod_chequereceipt_mint::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefChequeReceipts.

Definition at line 53 of file mod_chequereceipt_mint.php.


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