class mod_holiday_immaculate extends ModelNumRefHolidays (View source)

Class to manage holiday numbering rules Immaculate

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
$position

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)

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

string
getVersion()

Returns version of numbering module

string
getExample()

Return numbering example

string|int<-1, 0>
getNextValue(Societe $objsoc, Holiday $holiday)

Return next value

__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)

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

string getVersion()

Returns version of numbering module

Return Value

string Valeur

string getExample()

Return numbering example

Return Value

string Example

string|int<-1, 0> getNextValue(Societe $objsoc, Holiday $holiday)

Return next value

Parameters

Societe $objsoc

third party object

Holiday $holiday

holiday object

Return Value

string|int<-1, 0>

Value if OK, <=0 if KO

__construct()

Constructor