Parent class for number ref generators. More...
Public Member Functions | |
| getNom ($langs) | |
| Return model name. More... | |
| getName ($langs) | |
| Return model name. More... | |
| isEnabled () | |
| Return if a module can be used or not. More... | |
| info ($langs) | |
| Returns the default description of the numbering template. More... | |
| canBeActivated ($object) | |
| Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More... | |
| getVersion () | |
| Returns version of numbering module. More... | |
Detailed Description
Parent class for number ref generators.
Definition at line 31 of file commonnumrefgenerator.class.php.
Member Function Documentation
◆ canBeActivated()
| CommonNumRefGenerator::canBeActivated | ( | $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
- Returns
- boolean false if conflict, true if ok
Reimplemented in mod_recruitmentjobposition_standard, mod_recruitmentcandidature_standard, mod_partnership_standard, mod_myobject_standard, mod_workstation_standard, mod_ticket_simple, mod_takepos_ref_simple, mod_supplier_proposal_marbre, mod_supplier_payment_bronan, mod_commande_fournisseur_muguet, mod_facture_fournisseur_cactus, mod_stocktransfer_standard, mod_reception_beryl, mod_propale_marbre, mod_task_simple, mod_project_simple, mod_sn_standard, mod_lot_standard, mod_payment_cicada, mod_mo_standard, mod_member_simple, mod_member_advanced, mod_evaluation_standard, mod_holiday_madonna, mod_pacific, mod_facture_terre, mod_facture_mars, mod_expensereport_jade, mod_expedition_safor, mod_delivery_jade, mod_contract_serpis, mod_commande_marbre, mod_chequereceipt_mint, mod_bom_standard, and mod_asset_standard.
Definition at line 138 of file commonnumrefgenerator.class.php.
◆ getName()
| CommonNumRefGenerator::getName | ( | $langs | ) |
Return model name.
- Parameters
-
Translate $langs Object langs
- Returns
- string Model name
Definition at line 105 of file commonnumrefgenerator.class.php.
◆ getNom()
| CommonNumRefGenerator::getNom | ( | $langs | ) |
Return model name.
- Parameters
-
Translate $langs Object langs
- Returns
- string Model name
- Deprecated:
- Use getName() instead
- See also
- getName()
Definition at line 95 of file commonnumrefgenerator.class.php.
◆ getVersion()
| CommonNumRefGenerator::getVersion | ( | ) |
Returns version of numbering module.
- Returns
- string Valeur
Definition at line 148 of file commonnumrefgenerator.class.php.
◆ info()
| CommonNumRefGenerator::info | ( | $langs | ) |
Returns the default description of the numbering template.
- Parameters
-
Translate $langs Language
- Returns
- string Descriptive text
Reimplemented in mod_recruitmentjobposition_standard, mod_recruitmentjobposition_advanced, mod_recruitmentcandidature_standard, mod_recruitmentcandidature_advanced, mod_partnership_standard, mod_partnership_advanced, mod_myobject_standard, mod_myobject_advanced, mod_workstation_standard, mod_workstation_advanced, mod_ticket_universal, mod_ticket_simple, mod_takepos_ref_universal, mod_takepos_ref_simple, mod_supplier_proposal_saphir, mod_supplier_proposal_marbre, mod_supplier_payment_bronan, mod_supplier_payment_brodator, mod_commande_fournisseur_orchidee, mod_commande_fournisseur_muguet, mod_facture_fournisseur_tulip, mod_facture_fournisseur_cactus, mod_stocktransfer_standard, mod_stocktransfer_advanced, mod_codecompta_panicum, mod_codecompta_digitaria, mod_codecompta_aquarium, mod_codeclient_monkey, mod_codeclient_leopard, mod_codeclient_elephant, mod_reception_moonstone, mod_reception_beryl, mod_propale_saphir, mod_propale_marbre, mod_task_universal, mod_task_simple, mod_project_universal, mod_project_simple, mod_sn_standard, mod_sn_free, mod_sn_advanced, mod_lot_standard, mod_lot_free, mod_lot_advanced, mod_codeproduct_leopard, mod_codeproduct_elephant, mod_payment_cicada, mod_payment_ant, mod_mo_standard, mod_mo_advanced, mod_member_simple, mod_member_advanced, mod_evaluation_standard, mod_evaluation_advanced, mod_holiday_madonna, mod_holiday_immaculate, mod_pacific, mod_arctic, mod_facture_terre, mod_facture_mercure, mod_facture_mars, mod_expensereport_sand, mod_expensereport_jade, mod_expedition_safor, mod_expedition_ribera, mod_delivery_saphir, mod_delivery_jade, mod_contract_serpis, mod_contract_olive, mod_contract_magre, mod_commande_saphir, mod_commande_marbre, mod_chequereceipt_thyme, mod_chequereceipt_mint, mod_bom_standard, mod_bom_advanced, mod_barcode_thirdparty_standard, mod_barcode_product_standard, mod_asset_standard, and mod_asset_advanced.
Definition at line 126 of file commonnumrefgenerator.class.php.
◆ isEnabled()
| CommonNumRefGenerator::isEnabled | ( | ) |
Return if a module can be used or not.
- Returns
- boolean true if module can be used
Definition at line 115 of file commonnumrefgenerator.class.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/core/class/commonnumrefgenerator.class.php