class mod_facture_fournisseur_tulip extends ModeleNumRefSuppliersInvoices (View source)

\class mod_facture_fournisseur_tulip \brief Tulip Class of numbering models of suppliers invoices references

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

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 model numbering

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

Returns a numbering example

string|int<-1, 0>
getNextValue(Societe $objsoc, FactureFournisseur $object, string $mode = 'next')

Return next value

getNumRef($objsoc, FactureFournisseur $objforref, $mode = 'next')

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 model numbering

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

Returns a numbering example

@return string Example

Return Value

string Example

string|int<-1, 0> getNextValue(Societe $objsoc, FactureFournisseur $object, string $mode = 'next')

Return next value

Parameters

Societe $objsoc

Object third party

FactureFournisseur $object

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

getNumRef($objsoc, FactureFournisseur $objforref, $mode = 'next')

Return next free value

@param Societe $objsoc Object third party

Parameters

$objsoc
FactureFournisseur $objforref

Object for number to search @param string $mode 'next' for next value or 'last' for last value @return string Next free value @deprecated see getNextValue

$mode