class mod_delivery_saphir extends ModeleNumRefDeliveryOrder (View source)

\class mod_delivery_saphir \brief Class du modele de numerotation de reference de livraison Saphir

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
$nom

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 description of the numbering model

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()

Return an example of number

getNextValue($objsoc, Delivery $object)

Return next free value

getNumRef($objsoc, Delivery $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)

Returns the description of the numbering model

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()

Return an example of number

@return string Example

Return Value

string Example

getNextValue($objsoc, Delivery $object)

Return next free value

@param Societe $objsoc Object thirdparty

Parameters

$objsoc
Delivery $object

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

getNumRef($objsoc, Delivery $objforref)

Return next free value

@param Societe $objsoc Object third party

Parameters

$objsoc
Delivery $objforref

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