dolibarr  18.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 ()
 Return description of numbering module. More...
 
 getExample ()
 Return 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 ($objprod, $object)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefMos
 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 30 of file mod_mo_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_mo_standard::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 from ModeleNumRefMos.

Definition at line 80 of file mod_mo_standard.php.

◆ getExample()

mod_mo_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefMos.

Definition at line 68 of file mod_mo_standard.php.

◆ getNextValue()

mod_mo_standard::getNextValue (   $objprod,
  $object 
)

Return next free value.

Parameters
Product$objprodObject product
Object$objectObject we need next value for
Returns
string Value if KO, <0 if KO

Reimplemented from ModeleNumRefMos.

Definition at line 117 of file mod_mo_standard.php.

◆ info()

mod_mo_standard::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefMos.

Definition at line 56 of file mod_mo_standard.php.


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