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

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

Inheritance diagram for mod_lot_standard:
Inheritance graph
[legend]
Collaboration diagram for mod_lot_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 ($objsoc, $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 33 of file mod_lot_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_lot_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 KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 85 of file mod_lot_standard.php.

◆ getExample()

mod_lot_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 72 of file mod_lot_standard.php.

◆ getNextValue()

mod_lot_standard::getNextValue (   $objsoc,
  $object 
)

Return next free value.

Parameters
Societe$objsocObject thirdparty
Productlot$objectObject we need next value for
Returns
string|-1 Value if OK, -1 if KO

Definition at line 123 of file mod_lot_standard.php.

◆ info()

mod_lot_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 60 of file mod_lot_standard.php.


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