dolibarr 18.0.6
mod_arctic Class Reference

Class to manage numbering of intervention cards with rule Artic. More...

Inheritance diagram for mod_arctic:
Collaboration diagram for mod_arctic:

Public Member Functions

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

Detailed Description

Class to manage numbering of intervention cards with rule Artic.

Definition at line 33 of file mod_arctic.php.

Member Function Documentation

◆ getExample()

mod_arctic::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefFicheinter.

Definition at line 104 of file mod_arctic.php.

References getNextValue().

◆ getNextValue()

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

Return next free value.

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

Reimplemented from ModeleNumRefFicheinter.

Definition at line 126 of file mod_arctic.php.

References get_next_value(), and getDolGlobalString().

Referenced by getExample(), and getNumRef().

◆ getNumRef()

mod_arctic::getNumRef ( $objsoc,
$objforref )

Return next free value.

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

Definition at line 153 of file mod_arctic.php.

References getNextValue().

◆ info()

mod_arctic::info ( )

Returns the description of the numbering model.

Returns
string Descriptive text

Reimplemented from ModeleNumRefFicheinter.

Definition at line 64 of file mod_arctic.php.

References getDolGlobalString().


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