ModeleNumRefMyObject Class Reference

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

Inheritance diagram for ModeleNumRefMyObject:

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 ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($object)
	Returns next assigned value.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Parent class to manage numbering of MyObject.

Definition at line 105 of file modules_myobject.php.

Member Function Documentation

canBeActivated()

ModeleNumRefMyObject::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_myobject_standard.

Definition at line 153 of file modules_myobject.php.

getExample()

ModeleNumRefMyObject::getExample

(

)

Returns an example of numbering.

Returns

string Example

Reimplemented in mod_myobject_advanced, and mod_myobject_standard.

Definition at line 139 of file modules_myobject.php.

getNextValue()

ModeleNumRefMyObject::getNextValue

(

$object

)

Returns next assigned value.

Parameters

Object

$object

Object we need next value for

Returns

string Valeur

Reimplemented in mod_myobject_advanced, and mod_myobject_standard.

Definition at line 164 of file modules_myobject.php.

getVersion()

ModeleNumRefMyObject::getVersion

(

)

Returns version of numbering module.

Returns

string Valeur

Definition at line 175 of file modules_myobject.php.

info()

ModeleNumRefMyObject::info

(

)

Returns the default description of the numbering template.

Returns

string Descriptive text

Reimplemented in mod_myobject_advanced, and mod_myobject_standard.

Definition at line 127 of file modules_myobject.php.

isEnabled()

ModeleNumRefMyObject::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 117 of file modules_myobject.php.

---

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

• dolibarr_18.0/htdocs/modulebuilder/template/core/modules/mymodule/modules_myobject.php