dolibarr 18.0.6
ModeleNumRefFicheinter Class Reference

Parent class numbering models of intervention sheet references. More...

Inheritance diagram for ModeleNumRefFicheinter:

Public Member Functions

 isEnabled ()
 Return if a module can be used or not.
 
 info ()
 Returns the default description of the numbering template.
 
 getExample ()
 Return a numbering example.
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getNextValue ($objsoc=0, $object='')
 Return the next assigned value.
 
 getVersion ()
 Return the version of the numbering module.
 

Detailed Description

Parent class numbering models of intervention sheet references.

Definition at line 68 of file modules_fichinter.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefFicheinter::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_pacific.

Definition at line 118 of file modules_fichinter.php.

◆ getExample()

ModeleNumRefFicheinter::getExample ( )

Return a numbering example.

Returns
string Example

Reimplemented in mod_arctic, and mod_pacific.

Definition at line 105 of file modules_fichinter.php.

◆ getNextValue()

ModeleNumRefFicheinter::getNextValue ( $objsoc = 0,
$object = '' )

Return the next assigned value.

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

Reimplemented in mod_arctic, and mod_pacific.

Definition at line 130 of file modules_fichinter.php.

◆ getVersion()

ModeleNumRefFicheinter::getVersion ( )

Return the version of the numbering module.

Returns
string Value

Definition at line 141 of file modules_fichinter.php.

◆ info()

ModeleNumRefFicheinter::info ( )

Returns the default description of the numbering template.

Returns
string Descriptive text

Reimplemented in mod_arctic, and mod_pacific.

Definition at line 93 of file modules_fichinter.php.

◆ isEnabled()

ModeleNumRefFicheinter::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 83 of file modules_fichinter.php.


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