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

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

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

Public Member Functions

 info ($langs)
 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 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 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$objectObject 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$objectObject we need next value for
Returns
string|-1 Next free value if OK, -1 if KO

Definition at line 122 of file mod_myobject_standard.php.

◆ info()

mod_myobject_standard::info (   $langs)

Return description of numbering module.

Parameters
Translate$langsTranslate Object
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: