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 () | |
| 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... | |
| 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 Mint.
Definition at line 30 of file mod_chequereceipt_mint.php.
Member Function Documentation
| 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
Definition at line 77 of file mod_chequereceipt_mint.php.
References $resql.
| mod_chequereceipt_mint::chequereceipt_get_num | ( | $objsoc, | |
| $objforref | |||
| ) |
Return next free value.
- Parameters
-
Societe $objsoc Object third party string $objforref Object for number to search
- Returns
- string Next free value
Definition at line 154 of file mod_chequereceipt_mint.php.
References getNextValue().
| mod_chequereceipt_mint::getExample | ( | ) |
Return an example of numbering.
- Returns
- string Example
Definition at line 65 of file mod_chequereceipt_mint.php.
| mod_chequereceipt_mint::getNextValue | ( | $objsoc, | |
| $object | |||
| ) |
Return next free value.
- Parameters
-
Societe $objsoc Object thirdparty Object $object Object we need next value for
- Returns
- string Value if KO, <0 if KO
Definition at line 112 of file mod_chequereceipt_mint.php.
References $resql, and dol_syslog().
Referenced by chequereceipt_get_num().
| mod_chequereceipt_mint::info | ( | ) |
Return description of numbering module.
- Returns
- string Text with description
Definition at line 53 of file mod_chequereceipt_mint.php.
The documentation for this class was generated from the following file:
- htdocs/core/modules/cheque/mod_chequereceipt_mint.php