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

Class to manage contract numbering rules Serpis. More...

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

Public Member Functions

 __construct ()
 Constructor.
 
 info ($langs)
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ($object)
 Test if existing numbers make problems with numbering. More...
 
 getNextValue ($objsoc, $contract)
 Return next 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 contract numbering rules Serpis.

Definition at line 31 of file mod_contract_serpis.php.

Member Function Documentation

◆ canBeActivated()

mod_contract_serpis::canBeActivated (   $object)

Test if existing numbers make problems with numbering.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 82 of file mod_contract_serpis.php.

◆ getExample()

mod_contract_serpis::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 70 of file mod_contract_serpis.php.

◆ getNextValue()

mod_contract_serpis::getNextValue (   $objsoc,
  $contract 
)

Return next value.

Parameters
Societe$objsocthird party object
Contrat$contractcontract object
Returns
string|-1 Value if OK, -1 if KO

Definition at line 119 of file mod_contract_serpis.php.

◆ info()

mod_contract_serpis::info (   $langs)

Return default description of numbering model.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 58 of file mod_contract_serpis.php.


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