abstract class ModeleProductCode extends CommonNumRefGenerator (View source)

Class template for classes of numbering product

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
getExample(Translate $langs = null, Product|"" $objproduct = '', int<-1, 2> $type = -1)

Return an example of result returned by getNextValue

getNextValue(Product|"" $objproduct = '', int $type = -1)

Return next value available

static 
liste_modeles($dbs, int $maxfilenamelength = 0)

Renvoi la liste des modeles de numérotation

getToolTip($langs, Product|"" $product, $type)

Return description of module parameters

verif_prefixIsUsed()

Check if mask/numbering use prefix

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

string getExample(Translate $langs = null, Product|"" $objproduct = '', int<-1, 2> $type = -1)

Return an example of result returned by getNextValue

Parameters

Translate $langs

Object langs

Product|"" $objproduct

Object product

int<-1, 2> $type

Type of third party (1:customer, 2:supplier, -1:autodetect)

Return Value

string Example

getNextValue(Product|"" $objproduct = '', int $type = -1)

Return next value available

Parameters

Product|"" $objproduct

Object product

int $type

Type @return string Value

static liste_modeles($dbs, int $maxfilenamelength = 0)

Renvoi la liste des modeles de numérotation

@param DoliDB $dbs Database handler

Parameters

$dbs
int $maxfilenamelength

Max length of value to show @return array|int List of numbers

getToolTip($langs, Product|"" $product, $type)

Return description of module parameters

@param Translate $langs Output language

Parameters

$langs
Product|"" $product

Product object @param int<-1,1> $type -1=Nothing, 0=Customer, 1=Supplier @return string HTML translated description

$type

verif_prefixIsUsed()

Check if mask/numbering use prefix

@return int 0=no, 1=yes