dolibarr 18.0.6
mod_sn_standard Class Reference

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

Inheritance diagram for mod_sn_standard:
Collaboration diagram for mod_sn_standard:

Public Member Functions

 info ()
 Return description of numbering module.
 
 getExample ()
 Return an example of numbering.
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getNextValue ($objsoc, $object)
 Return next free value.
 
- Public Member Functions inherited from ModeleNumRefBatch
 isEnabled ()
 Return if a module can be used or not.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage MO numbering rules standard.

Definition at line 31 of file mod_sn_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_sn_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

Reimplemented from ModeleNumRefBatch.

Definition at line 81 of file mod_sn_standard.php.

◆ getExample()

mod_sn_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefBatch.

Definition at line 69 of file mod_sn_standard.php.

◆ getNextValue()

mod_sn_standard::getNextValue ( $objsoc,
$object )

Return next free value.

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

Reimplemented from ModeleNumRefBatch.

Definition at line 118 of file mod_sn_standard.php.

References dol_now(), and dol_syslog().

◆ info()

mod_sn_standard::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefBatch.

Definition at line 57 of file mod_sn_standard.php.


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