dolibarr  19.0.0-dev
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

 info ()
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ()
 Test if existing numbers make problems with numbering. More...
 
 getNextValue ($objsoc, $contract)
 Return next value. More...
 
 contract_get_num ($objsoc, $objforref)
 Return next value. More...
 
- Public Member Functions inherited from ModelNumRefContracts
 isEnabled ()
 Return if a module can be used or not. More...
 
 getVersion ()
 Return numbering version module. More...
 

Detailed Description

Class to manage contract numbering rules Serpis.

Definition at line 29 of file mod_contract_serpis.php.

Member Function Documentation

◆ canBeActivated()

mod_contract_serpis::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflit, true if ok

Reimplemented from ModelNumRefContracts.

Definition at line 90 of file mod_contract_serpis.php.

◆ contract_get_num()

mod_contract_serpis::contract_get_num (   $objsoc,
  $objforref 
)

Return next value.

Parameters
Societe$objsocthird party object
Object$objforrefcontract object
Returns
string Value if OK, 0 if KO

Definition at line 172 of file mod_contract_serpis.php.

◆ getExample()

mod_contract_serpis::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefContracts.

Definition at line 79 of file mod_contract_serpis.php.

◆ getNextValue()

mod_contract_serpis::getNextValue (   $objsoc,
  $contract 
)

Return next value.

Parameters
Societe$objsocthird party object
Object$contractcontract object
Returns
string Value if OK, 0 if KO

Reimplemented from ModelNumRefContracts.

Definition at line 127 of file mod_contract_serpis.php.

◆ info()

mod_contract_serpis::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented from ModelNumRefContracts.

Definition at line 67 of file mod_contract_serpis.php.


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