mod_contract_olive Class Reference

Class to manage contract numbering rules Olive. More...

Inheritance diagram for mod_contract_olive:

Collaboration diagram for mod_contract_olive:

Public Member Functions
	info ()
	Return description of module. More...
	getNextValue ($objsoc, $contract)
	Return an example of result returned by getNextValue. More...
	verif ($db, &$code, $product, $type)
	Check validity of code according to its rules. More...
Public Member Functions inherited from ModelNumRefContracts
	isEnabled ()
	Return if a module can be used or not. More...
	getExample ()
	Return numbering example. More...
	canBeActivated ()
	Test if existing numbers make problems with numbering. More...
	getVersion ()
	Return numbering version module. More...

Detailed Description

Class to manage contract numbering rules Olive.

Definition at line 33 of file mod_contract_olive.php.

Member Function Documentation

getNextValue()

mod_contract_olive::getNextValue	(		$objsoc,
			$contract
	)

Return an example of result returned by getNextValue.

Parameters

Societe	$objsoc	Object thirdparty
Contrat	$contract	Object contract

Returns

string Return next value

Reimplemented from ModelNumRefContracts.

Definition at line 87 of file mod_contract_olive.php.

info()

mod_contract_olive::info

(

)

Return description of module.

Returns

string Description of module

Reimplemented from ModelNumRefContracts.

Definition at line 72 of file mod_contract_olive.php.

verif()

mod_contract_olive::verif	(		$db,
		&	$code,
			$product,
			$type
	)

Check validity of code according to its rules.

Parameters

DoliDB	$db	Database handler
string	$code	Code to check/correct
Product	$product	Object product
int	$type	0 = product , 1 = service

Returns

int 0 if OK -1 ErrorBadProductCodeSyntax -2 ErrorProductCodeRequired -3 ErrorProductCodeAlreadyUsed -4 ErrorPrefixRequired

Definition at line 107 of file mod_contract_olive.php.

---

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

• dolibarr_17.0/htdocs/core/modules/contract/mod_contract_olive.php