mod_myobject_standard Class Reference
Class to manage the Standard numbering rule for MyObject. More...
Inheritance diagram for mod_myobject_standard:
Collaboration diagram for mod_myobject_standard:
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 ($object) | |
| 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. | |
| getVersion () | |
| Returns version of numbering module. | |
Detailed Description
Class to manage the Standard numbering rule for MyObject.
Definition at line 31 of file mod_myobject_standard.php.
Member Function Documentation
◆ canBeActivated()
| mod_myobject_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 82 of file mod_myobject_standard.php.
◆ getExample()
| mod_myobject_standard::getExample | ( | ) |
Return an example of numbering.
- Returns
- string Example
Definition at line 69 of file mod_myobject_standard.php.
◆ getNextValue()
| mod_myobject_standard::getNextValue | ( | $object | ) |
Return next free value.
- Parameters
-
Object $object Object we need next value for
- Returns
- string Value if KO, <0 if KO
Definition at line 122 of file mod_myobject_standard.php.
References dol_print_date(), and dol_syslog().
◆ info()
| mod_myobject_standard::info | ( | $langs | ) |
Return description of numbering module.
- Returns
- string Text with description
Reimplemented from CommonNumRefGenerator.
Definition at line 58 of file mod_myobject_standard.php.
The documentation for this class was generated from the following file:
- dolibarr_19.0/htdocs/modulebuilder/template/core/modules/mymodule/mod_myobject_standard.php
Generated on Wed Dec 4 2024 01:00:31 for dolibarr by Doxygen 1.11.0