dolibarr  18.0.0-alpha
Public Member Functions | List of all members
ModeleNumRefMos Class Reference

Parent class to manage numbering of MOs. More...

Inheritance diagram for ModeleNumRefMos:
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 MOs.

Definition at line 68 of file modules_mo.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefMos::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_mo_standard.

Definition at line 115 of file modules_mo.php.

◆ getExample()

ModeleNumRefMos::getExample ( )

Returns an example of numbering.

Returns
string Example

Reimplemented in mod_mo_advanced, and mod_mo_standard.

Definition at line 102 of file modules_mo.php.

◆ getNextValue()

ModeleNumRefMos::getNextValue (   $objsoc,
  $object 
)

Returns next assigned value.

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

Reimplemented in mod_mo_advanced, and mod_mo_standard.

Definition at line 127 of file modules_mo.php.

◆ getVersion()

ModeleNumRefMos::getVersion ( )

Returns version of numbering module.

Returns
string Valeur

Definition at line 138 of file modules_mo.php.

◆ info()

ModeleNumRefMos::info ( )

Returns the default description of the numbering template.

Returns
string Descriptive text

Reimplemented in mod_mo_advanced, and mod_mo_standard.

Definition at line 90 of file modules_mo.php.

◆ isEnabled()

ModeleNumRefMos::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 80 of file modules_mo.php.


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