ModeleNumRefBoms Class Reference

Parent class to manage numbering of BOMs. More...

Inheritance diagram for ModeleNumRefBoms:

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

Detailed Description

Parent class to manage numbering of BOMs.

Definition at line 68 of file modules_bom.php.

Member Function Documentation

canBeActivated()

ModeleNumRefBoms::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 in mod_bom_standard.

Definition at line 115 of file modules_bom.php.

getExample()

ModeleNumRefBoms::getExample

(

)

Returns an example of numbering.

Returns

string Example

Reimplemented in mod_bom_advanced, and mod_bom_standard.

Definition at line 102 of file modules_bom.php.

getNextValue()

ModeleNumRefBoms::getNextValue	(		$objsoc,
			$object )

Returns next assigned value.

Parameters

Societe	$objsoc	Object thirdparty
Object	$object	Object we need next value for

Returns

string Valeur

Reimplemented in mod_bom_advanced, and mod_bom_standard.

Definition at line 127 of file modules_bom.php.

getVersion()

ModeleNumRefBoms::getVersion

(

)

Returns version of numbering module.

Returns

string Valeur

Definition at line 138 of file modules_bom.php.

info()

ModeleNumRefBoms::info

(

)

Returns the default description of the numbering template.

Returns

string Descriptive text

Reimplemented in mod_bom_advanced, and mod_bom_standard.

Definition at line 90 of file modules_bom.php.

isEnabled()

ModeleNumRefBoms::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 80 of file modules_bom.php.

---

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

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