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

Inheritance diagram for ModelNumRefContracts:

[legend]

Public Member Functions
	isEnabled ()
	Return if a module can be used or not. More...

	info ()
	Return default description of numbering model. More...

	getExample ()
	Return numbering example. More...

	canBeActivated ()
	Test if existing numbers make problems with numbering. More...

	getNextValue ($objsoc, $contract)
	Return next value. More...

	getVersion ()
	Return numbering version module. More...

Detailed Description

Parent class for all contract numbering modules.

Definition at line 73 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 119 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 107 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_serpis, mod_contract_magre, and mod_contract_olive.

Definition at line 131 of file modules_contract.php.

◆ getVersion()

ModelNumRefContracts::getVersion ( )

Return numbering version module.

Returns: string Value

Definition at line 142 of file modules_contract.php.

◆ info()

ModelNumRefContracts::info ( )

Return default description of numbering model.

Returns: string text description

Reimplemented in mod_contract_olive, mod_contract_serpis, and mod_contract_magre.

Definition at line 95 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 85 of file modules_contract.php.

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

dolibarr_17.0/htdocs/core/modules/contract/modules_contract.php

Public Member Functions