dolibarr  18.0.0-alpha
Public Member Functions | List of all members
mod_contract_magre Class Reference

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

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

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...
 
 canBeActivated ()
 Test if existing numbers make problems with numbering. More...
 
 getVersion ()
 Return numbering version module. More...
 

Detailed Description

Class to manage contract numbering rules Magre.

Definition at line 31 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 150 of file mod_contract_magre.php.

◆ getExample()

mod_contract_magre::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefContracts.

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

Reimplemented from ModelNumRefContracts.

Definition at line 124 of file mod_contract_magre.php.

◆ info()

mod_contract_magre::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented from ModelNumRefContracts.

Definition at line 66 of file mod_contract_magre.php.


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