Class to manage the Standard numbering rule for Partnership. More...
Inheritance diagram for mod_partnership_standard:
Collaboration diagram for mod_partnership_standard:
Public Member Functions | |
| info ($langs) | |
| Return description of numbering module. More... | |
| getExample () | |
| Return an example of numbering. More... | |
| canBeActivated ($object) | |
| Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More... | |
| getNextValue ($object) | |
| Return next free value. More... | |
 Public Member Functions inherited from CommonNumRefGenerator | |
| getNom ($langs) | |
| Return model name. More... | |
| getName ($langs) | |
| Return model name. More... | |
| isEnabled () | |
| Return if a module can be used or not. More... | |
| getVersion () | |
| Returns version of numbering module. More... | |
Detailed Description
Class to manage the Standard numbering rule for Partnership.
Definition at line 32 of file mod_partnership_standard.php.
Member Function Documentation
◆ canBeActivated()
| mod_partnership_standard::canBeActivated | ( | $object | ) |
Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
- Parameters
-
Object $object Object we need next value for
- Returns
- boolean false if conflict, true if ok
Reimplemented from CommonNumRefGenerator.
Definition at line 83 of file mod_partnership_standard.php.
◆ getExample()
| mod_partnership_standard::getExample | ( | ) |
Return an example of numbering.
- Returns
- string Example
Definition at line 70 of file mod_partnership_standard.php.
◆ getNextValue()
| mod_partnership_standard::getNextValue | ( | $object | ) |
Return next free value.
- Parameters
-
Object $object Object we need next value for
- Returns
- string|-1 Next value if OK, -1 if KO
Definition at line 123 of file mod_partnership_standard.php.
◆ info()
| mod_partnership_standard::info | ( | $langs | ) |
Return description of numbering module.
- Parameters
-
Translate $langs Lang object to use for output
- Returns
- string Text with description
Reimplemented from CommonNumRefGenerator.
Definition at line 59 of file mod_partnership_standard.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/partnership/core/modules/partnership/mod_partnership_standard.php