mod_codeclient_elephant

class mod_codeclient_elephant extends ModeleThirdPartyCode (View source)

Class to manage third party 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
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
string
getExample(Translate $langs = null, Societe|string $objsoc = '', int<-1, 2> $type = -1)

Return an example of result returned by getNextValue

__construct($db)

Constructor

getNextValue(Societe|string|null $objsoc = '', int<-1, 2> $type = -1)

Return next value

static 
liste_modeles($dbs, int<0, max> $maxfilenamelength = 0)

Return list of active generation modules

from  ModeleThirdPartyCode
getToolTip($langs, Societe $soc, $type)

Return description of module parameters

from  ModeleThirdPartyCode
verif_prefixIsUsed()

Check if mask/numbering use prefix

verif(DoliDB $db, string $code, Societe $soc, $type)

Check validity of code according to its rules

verif_dispo($db, string $code, $soc, $type = 0)

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 82
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 180
string getExample(Translate $langs = null, Societe|string $objsoc = '', int<-1, 2> $type = -1)

Return an example of result returned by getNextValue

Parameters

Translate $langs

Object langs
Societe|string $objsoc

Object thirdparty
int<-1, 2> $type

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

Return Value

string Example

at line 63
__construct($db)

Constructor

Parameters

$db

at line 238
getNextValue(Societe|string|null $objsoc = '', int<-1, 2> $type = -1)

Return next value

Parameters

Societe|string|null $objsoc

Object thirdparty
int<-1, 2> $type

Type @return string Value

in ModeleThirdPartyCode at line 121
static liste_modeles($dbs, int<0, max> $maxfilenamelength = 0)

Return list of active generation modules

@param DoliDB $dbs Database handler

Parameters

$dbs
int<0, max> $maxfilenamelength

Max length of value to show @return string[]|int<-1,0> List of templates

in ModeleThirdPartyCode at line 151
getToolTip($langs, Societe $soc, $type)

Return description of module parameters

@param Translate $langs Output language

Parameters

$langs
Societe $soc

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

at line 283
verif_prefixIsUsed()

Check if mask/numbering use prefix

@return int 0 or 1

at line 317
verif(DoliDB $db, string $code, Societe $soc, $type)

Check validity of code according to its rules

Parameters

DoliDB $db

Database handler
string $code

Code to check/correct
Societe $soc

Object third party @param int<0,1> $type 0 = customer/prospect , 1 = supplier @return int<-6,0> 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 NotConfigured - Setup empty so any value may be ok or not -6 Other (see this->error)
$type

at line 373
verif_dispo($db, string $code, $soc, $type = 0)

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 Societe $soc Object societe @param int $type 0 = customer/prospect , 1 = supplier @return int 0 if available, <0 if KO
$soc
$type