ModeleNumRefMyObject Class Reference

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

Inheritance diagram for ModeleNumRefMyObject:

Collaboration diagram for ModeleNumRefMyObject:

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

Detailed Description

Parent class to manage numbering of MyObject.

Definition at line 81 of file modules_myobject.php.

Member Function Documentation

getExample()

ModeleNumRefMyObject::getExample ( )

abstract

Return an example of numbering.

Returns

string Example

Reimplemented in mod_myobject_advanced, and mod_myobject_standard.

getNextValue()

ModeleNumRefMyObject::getNextValue ( $object )

abstract

Return next free value.

Parameters

MyObject

$object

Object we need next value for

Returns

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

Reimplemented in mod_myobject_advanced, and mod_myobject_standard.

---

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

• dolibarr_dev/htdocs/modulebuilder/template/core/modules/mymodule/modules_myobject.php