ModelNumRefContracts Class Reference

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

Inheritance diagram for ModelNumRefContracts:

Collaboration diagram for ModelNumRefContracts:

Public Member Functions
	getNextValue ($objsoc, $contract)
	Return next value.
	getExample ()
	Return an example of numbering.
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.
	info ($langs)
	Returns the default description of the numbering template.
	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

Parent class for all contract numbering modules.

Definition at line 83 of file modules_contract.php.

Member Function Documentation

getExample()

ModelNumRefContracts::getExample ( )

abstract

Return an example of numbering.

Returns

string Example

Reimplemented in mod_contract_magre, mod_contract_olive, and mod_contract_serpis.

getNextValue()

ModelNumRefContracts::getNextValue ( $objsoc, $contract )

abstract

Return next value.

Parameters

Societe	$objsoc	third party object
Contrat	$contract	contract object

Returns

string|int<-1,0> Next value if OK, -1 or 0 if KO

Reimplemented in mod_contract_magre, mod_contract_olive, and mod_contract_serpis.

---

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

• dolibarr_dev/htdocs/core/modules/contract/modules_contract.php