ModeleAccountancyCode

abstract class ModeleAccountancyCode extends CommonNumRefGenerator (View source)

Parent class for third parties accountancy code generators

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
string $code

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)

Returns the default description of the numbering template

from  CommonNumRefGenerator
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
getToolTip($langs, Societe $soc, $type)

Return description of module parameters

get_code($db, Societe $societe, $type = '')

Set accountancy account code for a third party into this->code

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

Return an example of result returned by getNextValue

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

in CommonNumRefGenerator at line 127
string info(Translate $langs)

Returns the default description of the numbering template

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 260
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 302
get_code($db, Societe $societe, $type = '')

Set accountancy account code for a third party into this->code

@param DoliDB $db Database handler

Parameters

$db
Societe $societe

Third party object @param 'customer'|'supplier'|'' $type 'customer' or 'supplier' @return int<-1,1> >=0 if success, -1 if failure
$type

at line 319
abstract 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

Return string example