Class to manage customer order numbering rules standard. More...
Inheritance diagram for mod_myobject_standard:
Collaboration diagram for mod_myobject_standard:
Public Member Functions | |
| info () | |
| 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 ModeleNumRefMyObject | |
| 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 ($object) | |
| Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More... | |
| getNextValue ($object) | |
| Returns next assigned value. More... | |
| getVersion () | |
| Returns version of numbering module. More... | |
Detailed Description
Class to manage customer order numbering rules standard.
Definition at line 31 of file mod_myobject_standard.php.
Member Function Documentation
| 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
Definition at line 82 of file mod_myobject_standard.php.
References $resql.
| mod_myobject_standard::getExample | ( | ) |
Return an example of numbering.
- Returns
- string Example
Definition at line 69 of file mod_myobject_standard.php.
| 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 120 of file mod_myobject_standard.php.
References $resql, and dol_syslog().
| mod_myobject_standard::info | ( | ) |
Return description of numbering module.
- Returns
- string Text with description
Definition at line 57 of file mod_myobject_standard.php.
The documentation for this class was generated from the following file:
- htdocs/modulebuilder/template/core/modules/mymodule/mod_myobject_standard.php