abstract class ModeleNumRefKnowledgeRecord (View source)

Parent class to manage numbering of KnowledgeRecord

@property 'development'|'experimental'|'release' $version Version of "module"

Properties

string $error
string $name

Name of "module"

Methods

bool
isEnabled()

Return if a module can be used or not

string
info($langs)

Returns the default description of the numbering template

string
getExample()

Returns an example of numbering

bool
canBeActivated(object $object)

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

string|int<-1, 0>
getNextValue($object)

Return next free value

string
getVersion()

Returns version of numbering module

Details

bool isEnabled()

Return if a module can be used or not

Return Value

bool

true if module can be used

string info($langs)

Returns the default description of the numbering template

@param Translate $langs Object langs

Parameters

$langs

Return Value

string

Descriptive text

string getExample()

Returns an example of numbering

Return Value

string Example

bool canBeActivated(object $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

Return Value

bool

false if conflict, true if ok

string|int<-1, 0> getNextValue($object)

Return next free value

@param KnowledgeRecord $object Object we need next value for

Parameters

$object

Return Value

string|int<-1, 0>

Next value if OK, <=0 if KO

string getVersion()

Returns version of numbering module

Return Value

string Valeur