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.
	getExample ()
	Return numbering example.
	getNextValue ($objsoc, $contract)
	Return next value.
	contract_get_num ($objsoc, $objforref)
	Return next value.
Public Member Functions inherited from ModelNumRefContracts
	isEnabled ()
	Return if a module can be used or not.
	canBeActivated ()
	Test if existing numbers make problems with numbering.
	getVersion ()
	Return numbering version module.

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	$objsoc	third party object
Object	$objforref	contract object

Returns

string Value if OK, 0 if KO

Definition at line 150 of file mod_contract_magre.php.

References getNextValue().

getExample()

mod_contract_magre::getExample

(

)

Return numbering example.

Returns

string Example

Reimplemented from ModelNumRefContracts.

Definition at line 102 of file mod_contract_magre.php.

References getNextValue().

getNextValue()

mod_contract_magre::getNextValue	(		$objsoc,
			$contract )

Return next value.

Parameters

Societe	$objsoc	third party object
Object	$contract	contract object

Returns

string Value if OK, 0 if KO

Reimplemented from ModelNumRefContracts.

Definition at line 124 of file mod_contract_magre.php.

References get_next_value(), and getDolGlobalString().

Referenced by contract_get_num(), and getExample().

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.

References getDolGlobalString().

---

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

• dolibarr_18.0/htdocs/core/modules/contract/mod_contract_magre.php