mod_facture_mercure

class mod_facture_mercure extends ModeleNumRefFactures (View source)

Class of numbering module Mercure for invoices

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

from  CommonNumRefGenerator
string
getName($langs)

Return model name

from  CommonNumRefGenerator
bool
isEnabled()

Return if a module can be used or not

from  CommonNumRefGenerator
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.

from  CommonNumRefGenerator
string
getVersion()

Returns version of numbering module

from  CommonNumRefGenerator
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 number value

string|int
getNumRef(Societe $objsoc, Facture $objforref, string $mode = 'next') deprecated

Return next free value

Details

in CommonNumRefGenerator at line 96
string getNom($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

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

in CommonNumRefGenerator at line 106
string getName($langs)

Return model name

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

Model name

in CommonNumRefGenerator at line 116
bool isEnabled()

Return if a module can be used or not

Return Value

bool

true if module can be used

at line 68
string info(Translate $langs)

Returns the description of the numbering model

Parameters

Translate $langs Language

Return Value

string

Descriptive text

in CommonNumRefGenerator at line 139
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

in CommonNumRefGenerator at line 149
string getVersion()

Returns version of numbering module

Return Value

string Valeur

at line 163
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

at line 137
getExample()

Return an example of number value

@return string Example

at line 210
string|int getNumRef(Societe $objsoc, Facture $objforref, string $mode = 'next') deprecated

deprecated see getNextValue

Return next free value

Parameters

Societe $objsoc

Object third party
Facture $objforref

Object for number to search
string $mode

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

Return Value

string|int

Next free value, 0 if KO