abstract class ModeleNumRefFactures extends CommonNumRefGenerator (View source)

Parent class of invoice reference numbering templates

Properties

string $name from  CommonNumRefGenerator
string $version from  CommonNumRefGenerator
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

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|int<-1, 0>
getNextValue(Societe $objsoc, Facture $invoice, string $mode = 'next')

Return next value not used or last value used

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|int<-1, 0> getNextValue(Societe $objsoc, Facture $invoice, string $mode = 'next')

Return next value not used or last value used

Parameters

Societe $objsoc

Object third party

Facture $invoice

Object invoice

string $mode

'next' for next value or 'last' for last value

Return Value

string|int<-1, 0>

Value if OK, <=0 if KO

abstract getExample()

Return an example of numbering

@return string Example