mod_facture_terre
class mod_facture_terre extends ModeleNumRefFactures (View source)
Class of numbering module Terre for invoices
Properties
| string | $name | ||
| string | $version | Dolibarr version of the loaded document 'development', 'experimental', 'dolibarr' |
|
| 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 | |
| int | $position | ||
| string | $prefixinvoice | Prefix for invoices |
|
| string | $prefixreplacement | Prefix for replacement invoices |
|
| string | $prefixcreditnote | Prefix for credit note |
|
| string | $prefixdeposit | Prefix for deposit |
Methods
Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
Return next value not used or last value used.
Return an example of numbering
Constructor
Details
string
getNom($langs)
Return model name
@param Translate $langs Object langs
string
getName($langs)
Return model name
@param Translate $langs Object langs
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.
@param CommonObject $object Object we need next value for
string
getVersion()
Returns version of numbering module
string|int<-1, 0>
getNextValue(Societe $objsoc, Facture $invoice, string $mode = 'next')
Return next value not used or last value used.
Note to increase perf of this numbering engine, you can create a calculated column and modify request to use this field instead for select: ALTER TABLE llx_facture ADD COLUMN calculated_numrefonly INTEGER AS (CASE SUBSTRING(ref FROM 1 FOR 2) WHEN 'FA' THEN CAST(SUBSTRING(ref FROM 10) AS SIGNED) ELSE 0 END) PERSISTENT; ALTER TABLE llx_facture ADD INDEX calculated_numrefonly_idx (calculated_numrefonly);
getExample()
Return an example of numbering
@return string Example
__construct()
Constructor
getNumRef($objsoc, Facture $objforref, $mode = 'next')
Return next free value
@param Societe $objsoc Object third party