mod_bom_standard Class Reference

Class to manage the Standard numbering rule for BOM. More...

Inheritance diagram for mod_bom_standard:

Collaboration diagram for mod_bom_standard:

Public Member Functions
	info ()
	Return description of numbering module.
	getExample ()
	Return an example of numbering.
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($objprod, $object)
	Return next free value.
Public Member Functions inherited from ModeleNumRefBoms
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the Standard numbering rule for BOM.

Definition at line 30 of file mod_bom_standard.php.

Member Function Documentation

canBeActivated()

mod_bom_standard::canBeActivated

(

)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns

boolean false if conflict, true if ok

Reimplemented from ModeleNumRefBoms.

Definition at line 80 of file mod_bom_standard.php.

getExample()

mod_bom_standard::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefBoms.

Definition at line 68 of file mod_bom_standard.php.

getNextValue()

mod_bom_standard::getNextValue	(		$objprod,
			$object )

Return next free value.

Parameters

Product	$objprod	Object product
Object	$object	Object we need next value for

Returns

string Value if KO, <0 if KO

Reimplemented from ModeleNumRefBoms.

Definition at line 117 of file mod_bom_standard.php.

References dol_syslog().

info()

mod_bom_standard::info

(

)

Return description of numbering module.

Returns

string Text with description

Reimplemented from ModeleNumRefBoms.

Definition at line 56 of file mod_bom_standard.php.

---

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

• dolibarr_18.0/htdocs/core/modules/bom/mod_bom_standard.php