class mod_payment_cicada extends ModeleNumRefPayments (View source)

Class to manage customer payment numbering rules Cicada

Properties

string $name
string $version

Dolibarr version of the loaded document

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 $prefix
$nom
int $position

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 numbering module

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

getNextValue($objsoc, Paiement $object)

Return next free value

getExample()

Return an example of numbering

payment_get_num($objsoc, Paiement $objforref)

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 numbering module

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.

@param Object $object Object we need next value for

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

getNextValue($objsoc, Paiement $object)

Return next free value

@param Societe $objsoc Object thirdparty

Parameters

$objsoc
Paiement $object

Object we need next value for @return string|int<-1,0> Value if OK, <=0 if KO

getExample()

Return an example of numbering

@return string Example

payment_get_num($objsoc, Paiement $objforref)

Return next free value

@param Societe $objsoc Object third party

Parameters

$objsoc
Paiement $objforref

Object for number to search @return string|int<-1,0> Next free value, -1 if KO