dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_arctic Class Reference

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

Inheritance diagram for mod_arctic:
Inheritance graph
[legend]
Collaboration diagram for mod_arctic:
Collaboration graph
[legend]

Public Member Functions

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

Detailed Description

Class to manage numbering of intervention cards with rule Arctic.

Definition at line 34 of file mod_arctic.php.

Member Function Documentation

◆ getExample()

mod_arctic::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 106 of file mod_arctic.php.

◆ getNextValue()

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

Return next free value.

Parameters
Societe | string$objsocObject thirdparty
Fichinter | string$objectObject we need next value for
Returns
string|0 Value if OK, 0 if KO

Definition at line 128 of file mod_arctic.php.

◆ getNumRef()

mod_arctic::getNumRef (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
Fichinter$objforrefObject for number to search
Returns
string|0 Next free value, 0 if KO
Deprecated:
see getNextValue

Definition at line 159 of file mod_arctic.php.

◆ info()

mod_arctic::info (   $langs)

Returns the description of the numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 66 of file mod_arctic.php.


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