class mod_takepos_ref_universal extends ModeleNumRefTakepos (View source)

Class to manage ref numbering of takepos cards with rule universal.

Properties

string $name from  CommonNumRefGenerator
string $version

Dolibarr version of the loaded document 'development', 'experimental', 'dolibarr'

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

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)

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

Return next free value

getExample()

Return an example of numbering

string
getNumRef(Societe $objsoc, Facture $objforref) deprecated

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)

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

Return next free value

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>

Next ref value or last ref if $mode is 'last'

getExample()

Return an example of numbering

string getNumRef(Societe $objsoc, Facture $objforref) deprecated

deprecated see getNextValue

Return next free value

Parameters

Societe $objsoc

Object third party

Facture $objforref

Object for number to search

Return Value

string

Next free value