dolibarr 21.0.0-alpha
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

 __construct ()
 Constructor.
 
 info ($langs)
 Return default description of numbering model.
 
 getExample ()
 Return numbering example.
 
 getNextValue ($objsoc, $contract)
 Return next value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name.
 
 getName ($langs)
 Return model name.
 
 isEnabled ()
 Return if a module can be used or not.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage contract numbering rules Magre.

Definition at line 32 of file mod_contract_magre.php.

Member Function Documentation

◆ getExample()

mod_contract_magre::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefContracts.

Definition at line 90 of file mod_contract_magre.php.

References getNextValue().

◆ getNextValue()

mod_contract_magre::getNextValue ( $objsoc,
$contract )

Return next value.

Parameters
Societe$objsocthird party object
Contrat$contractcontract object
Returns
string|int<-1,0> Value if OK, <=0 if KO

Reimplemented from ModelNumRefContracts.

Definition at line 118 of file mod_contract_magre.php.

References get_next_value(), and getDolGlobalString().

Referenced by getExample().

◆ info()

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

References getDolGlobalString().


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