dolibarr  16.0.5
Public Member Functions | List of all members
ModeleNumRefBatch Class Reference

Parent class to manage numbering of batch products. More...

Inheritance diagram for ModeleNumRefBatch:
Inheritance graph
[legend]

Public Member Functions

 isEnabled ()
 Return if a module can be used or not. More...
 
 info ()
 Returns the default description of the numbering template. More...
 
 getExample ()
 Returns 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 ($objsoc, $object)
 Returns next assigned value. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Parent class to manage numbering of batch products.

Definition at line 72 of file modules_product_batch.class.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefBatch::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 in mod_lot_standard, and mod_sn_standard.

Definition at line 119 of file modules_product_batch.class.php.

◆ getExample()

ModeleNumRefBatch::getExample ( )

Returns an example of numbering.

Returns
string Example

Reimplemented in mod_lot_advanced, mod_sn_advanced, mod_lot_standard, and mod_sn_standard.

Definition at line 106 of file modules_product_batch.class.php.

◆ getNextValue()

ModeleNumRefBatch::getNextValue (   $objsoc,
  $object 
)

Returns next assigned value.

Parameters
Societe$objsocObject thirdparty
Object$objectObject we need next value for
Returns
string Valeur

Reimplemented in mod_lot_advanced, mod_sn_advanced, mod_lot_standard, mod_sn_standard, mod_lot_free, and mod_sn_free.

Definition at line 131 of file modules_product_batch.class.php.

◆ getVersion()

ModeleNumRefBatch::getVersion ( )

Returns version of numbering module.

Returns
string Valeur

Definition at line 142 of file modules_product_batch.class.php.

◆ info()

ModeleNumRefBatch::info ( )

Returns the default description of the numbering template.

Returns
string Texte descripif

Reimplemented in mod_lot_free, mod_sn_free, mod_lot_advanced, mod_sn_advanced, mod_lot_standard, and mod_sn_standard.

Definition at line 94 of file modules_product_batch.class.php.

◆ isEnabled()

ModeleNumRefBatch::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 84 of file modules_product_batch.class.php.


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