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

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

+ Inheritance diagram for mod_contract_magre:
+ Collaboration diagram for mod_contract_magre:

Public Member Functions

 info ()
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. 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 Magre.

Definition at line 30 of file mod_contract_magre.php.

Member Function Documentation

◆ contract_get_num()

mod_contract_magre::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 148 of file mod_contract_magre.php.

References getNextValue().

◆ getExample()

mod_contract_magre::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 98 of file mod_contract_magre.php.

◆ getNextValue()

mod_contract_magre::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 121 of file mod_contract_magre.php.

Referenced by contract_get_num().

◆ info()

mod_contract_magre::info ( )

Return default description of numbering model.

Returns
string text description

Definition at line 62 of file mod_contract_magre.php.


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