dolibarr 18.0.6
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 ()
 Return description of numbering module.
 
 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 31 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$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 82 of file mod_knowledgerecord_standard.php.

◆ getExample()

mod_knowledgerecord_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 69 of file mod_knowledgerecord_standard.php.

◆ getNextValue()

mod_knowledgerecord_standard::getNextValue ( $object)

Return next free value.

Parameters
Object$objectObject we need next value for
Returns
string Value if KO, <0 if KO

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 120 of file mod_knowledgerecord_standard.php.

References dol_syslog().

◆ info()

mod_knowledgerecord_standard::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefKnowledgeRecord.

Definition at line 57 of file mod_knowledgerecord_standard.php.


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