dolibarr  13.0.2
Public Member Functions | List of all members
mod_commande_marbre Class Reference

Class to manage customer order numbering rules Marbre. More...

+ Inheritance diagram for mod_commande_marbre:
+ Collaboration diagram for mod_commande_marbre:

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 ($objsoc, $object)
 Return next free value. More...
 
 commande_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefCommandes
 isEnabled ()
 Return if a module can be used or not. More...
 
 info ()
 Renvoie la description par defaut du modele de numerotation. More...
 
 getExample ()
 Renvoie un exemple de numerotation. 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

Class to manage customer order numbering rules Marbre.

Definition at line 30 of file mod_commande_marbre.php.

Member Function Documentation

mod_commande_marbre::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_commande_marbre.php.

References $resql.

mod_commande_marbre::commande_get_num (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
string$objforrefObject for number to search
Returns
string Next free value

Definition at line 157 of file mod_commande_marbre.php.

References getNextValue().

mod_commande_marbre::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 68 of file mod_commande_marbre.php.

mod_commande_marbre::getNextValue (   $objsoc,
  $object 
)

Return next free value.

Parameters
Societe$objsocObject thirdparty
Object$objectObject we need next value for
Returns
string Value if KO, <0 if KO

Definition at line 115 of file mod_commande_marbre.php.

References $resql, and dol_syslog().

Referenced by commande_get_num().

mod_commande_marbre::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 56 of file mod_commande_marbre.php.


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