abstract class CommonNumRefGenerator (View source)

Parent class for number ref generators

Properties

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

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)

Returns the default description of the numbering template

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 an example of numbering.

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)

Returns the default description of the numbering template

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

abstract string getExample()

Return an example of numbering.

Return Value

string Example