dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_mo_standard Class Reference

Class to manage MO numbering rules standard. More...

Inheritance diagram for mod_mo_standard:
Inheritance graph
[legend]
Collaboration diagram for mod_mo_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 ($objprod, $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 MO numbering rules standard.

Definition at line 32 of file mod_mo_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_mo_standard::canBeActivated (   $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 84 of file mod_mo_standard.php.

◆ getExample()

mod_mo_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 71 of file mod_mo_standard.php.

◆ getNextValue()

mod_mo_standard::getNextValue (   $objprod,
  $object 
)

Return next free value.

Parameters
Product$objprodObject product
Mo$objectObject we need next value for
Returns
string|-1 Value if OK, -1 if KO

Definition at line 121 of file mod_mo_standard.php.

◆ info()

mod_mo_standard::info (   $langs)

Return description of numbering module.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 59 of file mod_mo_standard.php.


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