CommonNumRefGenerator Class Reference

Parent class for number ref generators. More...

Inheritance diagram for CommonNumRefGenerator:

Public Member Functions
	getNom ($langs)
	Return model name.
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	info ($langs)
	Returns the default description of the numbering template.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

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_asset_standard, mod_bom_standard, mod_chequereceipt_mint, mod_commande_fournisseur_muguet, mod_commande_marbre, mod_contract_serpis, mod_delivery_jade, mod_evaluation_standard, mod_expedition_safor, mod_expensereport_jade, mod_facture_fournisseur_cactus, mod_facture_mars, mod_facture_terre, mod_holiday_madonna, mod_lot_standard, mod_member_advanced, mod_member_simple, mod_mo_standard, mod_myobject_standard, mod_pacific, mod_partnership_standard, mod_payment_cicada, mod_project_simple, mod_propale_marbre, mod_reception_beryl, mod_recruitmentcandidature_standard, mod_recruitmentjobposition_standard, mod_sn_standard, mod_stocktransfer_standard, mod_supplier_payment_bronan, mod_supplier_proposal_marbre, mod_takepos_ref_simple, mod_task_simple, mod_ticket_simple, and mod_workstation_standard.

Definition at line 139 of file commonnumrefgenerator.class.php.

getName()

CommonNumRefGenerator::getName

(

$langs

)

Return model name.

Parameters

Translate

$langs

Object langs

Returns

string Model name

Definition at line 106 of file commonnumrefgenerator.class.php.

References name.

Referenced by getNom(), ModeleNumRefBarCode\getToolTip(), ModeleNumRefMembers\getToolTip(), ModeleProductCode\getToolTip(), and ModeleThirdPartyCode\getToolTip().

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 96 of file commonnumrefgenerator.class.php.

References getName().

getVersion()

CommonNumRefGenerator::getVersion

(

)

Returns version of numbering module.

Returns

string Valeur

Definition at line 149 of file commonnumrefgenerator.class.php.

Referenced by ModeleAccountancyCode\getToolTip(), ModeleNumRefBarCode\getToolTip(), ModeleNumRefMembers\getToolTip(), and ModeleProductCode\getToolTip().

info()

CommonNumRefGenerator::info

(

$langs

)

Returns the default description of the numbering template.

Parameters

Translate

$langs

Language

Returns

string Descriptive text

Reimplemented in mod_arctic, mod_asset_advanced, mod_asset_standard, mod_barcode_product_standard, mod_barcode_thirdparty_standard, mod_bom_advanced, mod_bom_standard, mod_chequereceipt_mint, mod_chequereceipt_thyme, mod_codeclient_elephant, mod_codeclient_leopard, mod_codeclient_monkey, mod_codecompta_aquarium, mod_codecompta_digitaria, mod_codecompta_panicum, mod_codeproduct_elephant, mod_codeproduct_leopard, mod_commande_fournisseur_muguet, mod_commande_fournisseur_orchidee, mod_commande_marbre, mod_commande_saphir, mod_contract_magre, mod_contract_olive, mod_contract_serpis, mod_delivery_jade, mod_delivery_saphir, mod_evaluation_advanced, mod_evaluation_standard, mod_expedition_ribera, mod_expedition_safor, mod_expensereport_jade, mod_expensereport_sand, mod_facture_fournisseur_cactus, mod_facture_fournisseur_tulip, mod_facture_mars, mod_facture_mercure, mod_facture_terre, mod_holiday_immaculate, mod_holiday_madonna, mod_lot_advanced, mod_lot_free, mod_lot_standard, mod_member_advanced, mod_member_simple, mod_mo_advanced, mod_mo_standard, mod_myobject_advanced, mod_myobject_standard, mod_pacific, mod_partnership_advanced, mod_partnership_standard, mod_payment_ant, mod_payment_cicada, mod_project_simple, mod_project_universal, mod_propale_marbre, mod_propale_saphir, mod_reception_beryl, mod_reception_moonstone, mod_recruitmentcandidature_advanced, mod_recruitmentcandidature_standard, mod_recruitmentjobposition_advanced, mod_recruitmentjobposition_standard, mod_sn_advanced, mod_sn_free, mod_sn_standard, mod_stocktransfer_advanced, mod_stocktransfer_standard, mod_supplier_payment_brodator, mod_supplier_payment_bronan, mod_supplier_proposal_marbre, mod_supplier_proposal_saphir, mod_takepos_ref_simple, mod_takepos_ref_universal, mod_task_simple, mod_task_universal, mod_ticket_simple, mod_ticket_universal, mod_workstation_advanced, and mod_workstation_standard.

Definition at line 127 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 116 of file commonnumrefgenerator.class.php.

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/core/class/commonnumrefgenerator.class.php