Class to manage the numbering module Simple for project references. More...
Inheritance diagram for mod_task_simple:
Collaboration diagram for mod_task_simple:
Public Member Functions | |
| info ($langs) | |
| Return description of numbering module. More... | |
| getExample () | |
| Return an example of numbering module values. More... | |
| canBeActivated ($object) | |
| Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More... | |
| getNextValue ($objsoc, $object) | |
| Return next 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 numbering module Simple for project references.
Definition at line 34 of file mod_task_simple.php.
Member Function Documentation
◆ canBeActivated()
| mod_task_simple::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 KO (there is a conflict), true if OK
Reimplemented from CommonNumRefGenerator.
Definition at line 93 of file mod_task_simple.php.
◆ getExample()
| mod_task_simple::getExample | ( | ) |
Return an example of numbering module values.
- Returns
- string Example
Definition at line 80 of file mod_task_simple.php.
◆ getNextValue()
| mod_task_simple::getNextValue | ( | $objsoc, | |
| $object | |||
| ) |
Return next value.
- Returns
- string|-1 Value if OK, -1 if KO
Definition at line 131 of file mod_task_simple.php.
◆ info()
| mod_task_simple::info | ( | $langs | ) |
Return description of numbering module.
- Parameters
-
Translate $langs Lang object to use for output
- Returns
- string Descriptive text
Reimplemented from CommonNumRefGenerator.
Definition at line 68 of file mod_task_simple.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/modules/project/task/mod_task_simple.php