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

Class to manage Sales Order numbering rules Marbre. More...

Inheritance diagram for mod_commande_marbre:
Inheritance graph
[legend]
Collaboration diagram for mod_commande_marbre:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 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 Sales Order numbering rules Marbre.

Definition at line 32 of file mod_commande_marbre.php.

Member Function Documentation

◆ canBeActivated()

mod_commande_marbre::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 96 of file mod_commande_marbre.php.

◆ getExample()

mod_commande_marbre::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 83 of file mod_commande_marbre.php.

◆ getNextValue()

mod_commande_marbre::getNextValue (   $objsoc,
  $object 
)

Return next free value.

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

Definition at line 133 of file mod_commande_marbre.php.

◆ info()

mod_commande_marbre::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 71 of file mod_commande_marbre.php.


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