mod_knowledgerecord_standard Class Reference

Class to manage the knowledgerecord numbering rules standard. More...

Inheritance diagram for mod_knowledgerecord_standard:

Collaboration diagram for mod_knowledgerecord_standard:

Public Member Functions
	info ($langs)
	Returns the default description of the numbering template.
	getExample ()
	Return 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.
Public Member Functions inherited from ModeleNumRefKnowledgeRecord
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the knowledgerecord numbering rules standard.

Definition at line 32 of file mod_knowledgerecord_standard.php.

Member Function Documentation

canBeActivated()

mod_knowledgerecord_standard::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 from ModeleNumRefKnowledgeRecord.

Definition at line 86 of file mod_knowledgerecord_standard.php.

References $object.

getExample()

mod_knowledgerecord_standard::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 73 of file mod_knowledgerecord_standard.php.

getNextValue()

mod_knowledgerecord_standard::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 from ModeleNumRefKnowledgeRecord.

Definition at line 126 of file mod_knowledgerecord_standard.php.

References $object, dol_print_date(), and dol_syslog().

info()

mod_knowledgerecord_standard::info

(

$langs

)

Returns the default description of the numbering template.

Parameters

Translate

$langs

Object langs

Returns

string Descriptive text

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 62 of file mod_knowledgerecord_standard.php.

---

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

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