class mod_contract_serpis extends ModelNumRefContracts (View source)

Class to manage contract numbering rules Serpis

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
string $prefix

Methods

string
getNom($langs)

Return model name

string
getName($langs)

Return model name

bool
isEnabled()

Return if a module can be used or not

string
info(Translate $langs)

Return default description of numbering model

bool
canBeActivated(CommonObject $object)

Test if existing numbers make problems with numbering

string
getVersion()

Returns version of numbering module

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

Return next value

getExample()

Return numbering example

__construct()

Constructor

Details

string getNom($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

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

string getName($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

Model name

bool isEnabled()

Return if a module can be used or not

Return Value

bool

true if module can be used

string info(Translate $langs)

Return default description of numbering model

Parameters

Translate $langs Language

Return Value

string

Descriptive text

bool canBeActivated(CommonObject $object)

Test if existing numbers make problems with numbering

@param CommonObject $object Object we need next value for

Parameters

CommonObject $object

Object we need next value for

Return Value

bool

false if conflict, true if ok

string getVersion()

Returns version of numbering module

Return Value

string Valeur

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

Return next value

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

getExample()

Return numbering example

__construct()

Constructor