mod_contract_olive

class mod_contract_olive extends ModelNumRefContracts (View source)

Class to manage contract numbering rules Olive

Properties

$name
$version
string $error from  CommonNumRefGenerator
string[] $errors from  CommonNumRefGenerator
protected DoliDB $db from  CommonNumRefGenerator
int<0, 1> $code_null from  CommonNumRefGenerator
int<0, 1> $code_modifiable from  CommonNumRefGenerator
int<0, 1> $code_modifiable_invalide from  CommonNumRefGenerator
int<0, 1> $code_modifiable_null from  CommonNumRefGenerator
int<0, 1> $code_auto from  CommonNumRefGenerator
int<0, 1> $prefixIsRequired from  CommonNumRefGenerator

Methods

string
getNom($langs)

Return model name

from  CommonNumRefGenerator
string
getName($langs)

Return model name

from  CommonNumRefGenerator
bool
isEnabled()

Return if a module can be used or not

from  CommonNumRefGenerator
string
info(Translate $langs)

Return description of module

bool
canBeActivated(CommonObject $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

from  CommonNumRefGenerator
string
getVersion()

Returns version of numbering module

from  CommonNumRefGenerator
string|int<-1, 0>
getNextValue(Societe $objsoc, Contrat $contract)

Return an example of result returned by getNextValue

getExample()

Return numbering example

__construct()

Constructor

verif(DoliDB $db, string $code, Product $product, $type)

Check validity of code according to its rules

Details

in CommonNumRefGenerator at line 96
string getNom($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

Model name @deprecated Use getName() instead getName()

in CommonNumRefGenerator at line 106
string getName($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

Model name

in CommonNumRefGenerator at line 116
bool isEnabled()

Return if a module can be used or not

Return Value

bool

true if module can be used

at line 59
string info(Translate $langs)

Return description of module

Parameters

Translate $langs Language

Return Value

string

Descriptive text

in CommonNumRefGenerator at line 139
bool canBeActivated(CommonObject $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters

CommonObject $object

Object we need next value for

Return Value

bool

false if conflict, true if ok

in CommonNumRefGenerator at line 149
string getVersion()

Returns version of numbering module

Return Value

string Valeur

at line 84
string|int<-1, 0> getNextValue(Societe $objsoc, Contrat $contract)

Return an example of result returned by getNextValue

Parameters

Societe $objsoc

third party object
Contrat $contract

contract object

Return Value

string|int<-1, 0>

Next value if OK, -1 or 0 if KO

at line 72
getExample()

Return numbering example

at line 45
__construct()

Constructor

at line 103
verif(DoliDB $db, string $code, Product $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 @param int $type 0 = product , 1 = service @return int 0 if OK -1 ErrorBadProductCodeSyntax -2 ErrorProductCodeRequired -3 ErrorProductCodeAlreadyUsed -4 ErrorPrefixRequired
$type