Parent class to manage numbering of BOMs. More...
Public Member Functions | |
| isEnabled () | |
| Return if a module can be used or not. More... | |
| info () | |
| Returns the default description of the numbering template. More... | |
| getExample () | |
| Returns 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) | |
| Returns next assigned value. More... | |
| getVersion () | |
| Returns version of numbering module. More... | |
Detailed Description
Parent class to manage numbering of BOMs.
Definition at line 68 of file modules_bom.php.
Member Function Documentation
◆ canBeActivated()
| ModeleNumRefBoms::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 in mod_bom_standard.
Definition at line 115 of file modules_bom.php.
◆ getExample()
| ModeleNumRefBoms::getExample | ( | ) |
Returns an example of numbering.
- Returns
- string Example
Reimplemented in mod_bom_standard, and mod_bom_advanced.
Definition at line 102 of file modules_bom.php.
◆ getNextValue()
| ModeleNumRefBoms::getNextValue | ( | $objsoc, | |
| $object | |||
| ) |
Returns next assigned value.
- Parameters
-
Societe $objsoc Object thirdparty Object $object Object we need next value for
- Returns
- string Valeur
Reimplemented in mod_bom_standard, and mod_bom_advanced.
Definition at line 127 of file modules_bom.php.
◆ getVersion()
| ModeleNumRefBoms::getVersion | ( | ) |
Returns version of numbering module.
- Returns
- string Valeur
Definition at line 138 of file modules_bom.php.
◆ info()
| ModeleNumRefBoms::info | ( | ) |
Returns the default description of the numbering template.
- Returns
- string Descriptive text
Reimplemented in mod_bom_standard, and mod_bom_advanced.
Definition at line 90 of file modules_bom.php.
◆ isEnabled()
| ModeleNumRefBoms::isEnabled | ( | ) |
Return if a module can be used or not.
- Returns
- boolean true if module can be used
Definition at line 80 of file modules_bom.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/modules/bom/modules_bom.php