mod_codeproduct_elephant

class mod_codeproduct_elephant extends ModeleProductCode (View source)

Class to manage product code with elephant rule

Properties

$name
$version
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
int $position
string $searchcode
int $numbitcounter

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)

Return description of module

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
getNextValue(Product|"" $objproduct = null, int $type = -1)

Return next value

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

Renvoi la liste des modeles de numérotation

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

Return description of module parameters

from  ModeleProductCode
verif_prefixIsUsed()

Check if mask/numbering use prefix

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

Return an example of result returned by getNextValue

__construct()

Constructor

verif(DoliDB $db, string $code, Product $product, $type)

Check validity of code according to its rules

verif_dispo($db, string $code, $product)

Indicate if the code is available or not (by another third party)

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 80
string info(Translate $langs)

Return description of module

@param Translate $langs Object langs

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 178
getNextValue(Product|"" $objproduct = null, int $type = -1)

Return next value

Parameters

Product|"" $objproduct

Object product
int $type

Type @return string Value

in ModeleProductCode at line 102
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

in ModeleProductCode at line 131
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

at line 227
verif_prefixIsUsed()

Check if mask/numbering use prefix

@return int 0 or 1

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

Return string example

at line 63
__construct()

Constructor

at line 260
verif(DoliDB $db, string $code, Product $product, $type)

Check validity of code according to its rules

Parameters

DoliDB $db

Database handler
string $code

Code to check/correct
Product $product

Object product @param int $type 0 = product , 1 = service @return int 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 Other (see this->error)
$type

at line 308
verif_dispo($db, string $code, $product)

Indicate if the code is available or not (by another third party)

@param DoliDB $db Handler access base

Parameters

$db
string $code

Code a verifier @param Product $product Object product @return int 0 if available, <0 if KO
$product