Cactus Class of numbering models of suppliers invoices references. More...
Public Member Functions | |
| info ($langs) | |
| Return description of numbering model. More... | |
| getExample () | |
| Returns a numbering example. More... | |
| canBeActivated ($object) | |
| Tests if the numbers already in the database do not cause conflicts that would prevent this numbering. More... | |
| getNextValue ($objsoc, $object, $mode='next') | |
| Return next value. More... | |
| getNumRef ($objsoc, $objforref, $mode='next') | |
| Return next free value. More... | |
 Public Member Functions inherited from CommonNumRefGenerator | |
| getNom ($langs) | |
| Return model name. More... | |
| getName ($langs) | |
| Return model name. More... | |
| isEnabled () | |
| Return if a module can be used or not. More... | |
| getVersion () | |
| Returns version of numbering module. More... | |
Detailed Description
Cactus Class of numbering models of suppliers invoices references.
Definition at line 36 of file mod_facture_fournisseur_cactus.php.
Member Function Documentation
◆ canBeActivated()
| mod_facture_fournisseur_cactus::canBeActivated | ( | $object | ) |
Tests if the numbers already in the database do not cause conflicts that would prevent this numbering.
- Parameters
-
CommonObject $object Object we need next value for
- Returns
- boolean false if KO (there is a conflict), true if OK
Reimplemented from CommonNumRefGenerator.
Definition at line 99 of file mod_facture_fournisseur_cactus.php.
◆ getExample()
| mod_facture_fournisseur_cactus::getExample | ( | ) |
Returns a numbering example.
- Returns
- string Example
Definition at line 87 of file mod_facture_fournisseur_cactus.php.
◆ getNextValue()
| mod_facture_fournisseur_cactus::getNextValue | ( | $objsoc, | |
| $object, | |||
$mode = 'next' |
|||
| ) |
Return next value.
- Parameters
-
Societe $objsoc Object third party FactureFournisseur $object Object invoice string $mode 'next' for next value or 'last' for last value
- Returns
- string|-1 Value if OK, -1 if KO
Definition at line 183 of file mod_facture_fournisseur_cactus.php.
◆ getNumRef()
| mod_facture_fournisseur_cactus::getNumRef | ( | $objsoc, | |
| $objforref, | |||
$mode = 'next' |
|||
| ) |
Return next free value.
- Parameters
-
Societe $objsoc Object third party FactureFournisseur $objforref Object for number to search string $mode 'next' for next value or 'last' for last value
- Returns
- string Next free value
- Deprecated:
- see getNextValue
Definition at line 267 of file mod_facture_fournisseur_cactus.php.
◆ info()
| mod_facture_fournisseur_cactus::info | ( | $langs | ) |
Return description of numbering model.
- Parameters
-
Translate $langs Lang object to use for output
- Returns
- string Descriptive text
Reimplemented from CommonNumRefGenerator.
Definition at line 74 of file mod_facture_fournisseur_cactus.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php