class mod_member_custom extends ModeleNumRefMembers (View source)

Class to manage member report numbering rules Custom

Properties

string $name
string $version

Dolibarr version of the loaded document

string $error
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
int $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)

Returns the description of the 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 an example of numbering

getToolTip($langs, Societe $soc)

Return description of module parameters

getNextValue($objsoc, Adherent $object)

Return next free value

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

@return string Example

Return Value

string Example

getToolTip($langs, Societe $soc)

Return description of module parameters

@param Translate $langs Output language

Parameters

$langs
Societe $soc

Third party object @return string HTML translated description

getNextValue($objsoc, Adherent $object)

Return next free value

@param ?Societe $objsoc Object third party

Parameters

$objsoc
Adherent $object

Object we need next value for @return string|int<-1,0> next value