ModelNumRefContracts Class Reference

Parent class for all contract numbering modules. More...

Inheritance diagram for ModelNumRefContracts:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	info ()
	Return default description of numbering model.
	getExample ()
	Return numbering example.
	canBeActivated ()
	Test if existing numbers make problems with numbering.
	getNextValue ($objsoc, $contract)
	Return next value.
	getVersion ()
	Return numbering version module.

Detailed Description

Parent class for all contract numbering modules.

Definition at line 71 of file modules_contract.php.

Member Function Documentation

canBeActivated()

ModelNumRefContracts::canBeActivated

(

)

Test if existing numbers make problems with numbering.

Returns

boolean false if conflict, true if ok

Reimplemented in mod_contract_serpis.

Definition at line 117 of file modules_contract.php.

getExample()

ModelNumRefContracts::getExample

(

)

Return numbering example.

Returns

string Example

Reimplemented in mod_contract_magre, and mod_contract_serpis.

Definition at line 105 of file modules_contract.php.

getNextValue()

ModelNumRefContracts::getNextValue	(		$objsoc,
			$contract )

Return next value.

Parameters

Societe	$objsoc	third party object
Object	$contract	contract object

Returns

string Value

Reimplemented in mod_contract_magre, mod_contract_olive, and mod_contract_serpis.

Definition at line 129 of file modules_contract.php.

getVersion()

ModelNumRefContracts::getVersion

(

)

Return numbering version module.

Returns

string Value

Definition at line 140 of file modules_contract.php.

info()

ModelNumRefContracts::info

(

)

Return default description of numbering model.

Returns

string text description

Reimplemented in mod_contract_magre, mod_contract_olive, and mod_contract_serpis.

Definition at line 93 of file modules_contract.php.

isEnabled()

ModelNumRefContracts::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 83 of file modules_contract.php.

---

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

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