dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
mod_contract_serpis Class Reference

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

+ Inheritance diagram for mod_contract_serpis:
+ Collaboration diagram for mod_contract_serpis:

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...
 
 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...
 
 getVersion ()
 Return numbering version module. More...
 

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

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

Definition at line 87 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 164 of file mod_contract_serpis.php.

References getNextValue().

◆ getExample()

mod_contract_serpis::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 76 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

Definition at line 122 of file mod_contract_serpis.php.

Referenced by contract_get_num().

◆ info()

mod_contract_serpis::info ( )

Return default description of numbering model.

Returns
string text description

Definition at line 64 of file mod_contract_serpis.php.


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