dolibarr  17.0.4
Public Member Functions | List of all members
mod_bom_standard Class Reference

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

Inheritance diagram for mod_bom_standard:
Inheritance graph
[legend]
Collaboration diagram for mod_bom_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...
 

Detailed Description

Class to manage the Standard numbering rule for BOM.

Definition at line 30 of file mod_bom_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_bom_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

Definition at line 80 of file mod_bom_standard.php.

◆ getExample()

mod_bom_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 68 of file mod_bom_standard.php.

◆ getNextValue()

mod_bom_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

Definition at line 117 of file mod_bom_standard.php.

◆ info()

mod_bom_standard::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 56 of file mod_bom_standard.php.


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