ModeleNumRefKnowledgeRecord Class Reference

Inheritance diagram for ModeleNumRefKnowledgeRecord:

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

Detailed Description

Definition at line 88 of file modules_knowledgerecord.php.

Member Function Documentation

canBeActivated()

ModeleNumRefKnowledgeRecord::canBeActivated

(

$object

)

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

Parameters

Object

$object

Object we need next value for

Returns

boolean false if conflict, true if ok

Reimplemented in mod_knowledgerecord_standard.

Definition at line 136 of file modules_knowledgerecord.php.

getExample()

ModeleNumRefKnowledgeRecord::getExample

(

)

Returns an example of numbering.

Returns

string Example

Reimplemented in mod_knowledgerecord_advanced, and mod_knowledgerecord_standard.

Definition at line 122 of file modules_knowledgerecord.php.

getNextValue()

ModeleNumRefKnowledgeRecord::getNextValue

(

$object

)

Return next free value.

Parameters

KnowledgeRecord

$object

Object we need next value for

Returns

string|int<-1,0> Next value if OK, <=0 if KO

Reimplemented in mod_knowledgerecord_advanced, and mod_knowledgerecord_standard.

Definition at line 147 of file modules_knowledgerecord.php.

getVersion()

ModeleNumRefKnowledgeRecord::getVersion

(

)

Returns version of numbering module.

Returns

string Valeur

Definition at line 158 of file modules_knowledgerecord.php.

info()

ModeleNumRefKnowledgeRecord::info

(

$langs

)

Returns the default description of the numbering template.

Parameters

Translate

$langs

Object langs

Returns

string Descriptive text

Reimplemented in mod_knowledgerecord_advanced, and mod_knowledgerecord_standard.

Definition at line 111 of file modules_knowledgerecord.php.

isEnabled()

ModeleNumRefKnowledgeRecord::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 100 of file modules_knowledgerecord.php.

---

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

• dolibarr_dev/htdocs/knowledgemanagement/core/modules/knowledgemanagement/modules_knowledgerecord.php