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

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

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

Public Member Functions

 info ($langs)
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. 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...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage numbering of intervention cards with rule Pacific.

Definition at line 33 of file mod_pacific.php.

Member Function Documentation

◆ canBeActivated()

mod_pacific::canBeActivated (   $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 90 of file mod_pacific.php.

◆ getExample()

mod_pacific::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 78 of file mod_pacific.php.

◆ getNextValue()

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

Return next free value.

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

Definition at line 129 of file mod_pacific.php.

◆ getNumRef()

mod_pacific::getNumRef (   $objsoc,
  $objforref 
)

Return next free value.

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

Definition at line 174 of file mod_pacific.php.

◆ info()

mod_pacific::info (   $langs)

Return description of numbering module.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 67 of file mod_pacific.php.


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