dolibarr  20.0.0-beta
Public Member Functions | List of all members
mod_myobject_advanced Class Reference

Class to manage the Advanced numbering rule for MyObject. More...

Inheritance diagram for mod_myobject_advanced:
Inheritance graph
[legend]
Collaboration diagram for mod_myobject_advanced:
Collaboration graph
[legend]

Public Member Functions

 info ($langs)
 Returns the description of the numbering model. More...
 
 getExample ()
 Return an example of numbering. 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...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage the Advanced numbering rule for MyObject.

Definition at line 35 of file mod_myobject_advanced.php.

Member Function Documentation

◆ getExample()

mod_myobject_advanced::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 98 of file mod_myobject_advanced.php.

◆ getNextValue()

mod_myobject_advanced::getNextValue (   $object)

Return next free value.

Parameters
Object$objectObject we need next value for
Returns
string|0 Next value if OK, 0 if KO

Definition at line 127 of file mod_myobject_advanced.php.

◆ info()

mod_myobject_advanced::info (   $langs)

Returns the description of the numbering model.

Parameters
Translate$langsTranslate Object
Returns
string Text with description

Reimplemented from CommonNumRefGenerator.

Definition at line 60 of file mod_myobject_advanced.php.


The documentation for this class was generated from the following file: