mod_myobject_advanced Class Reference

Class to manage the Advanced numbering rule for MyObject. More...

Inheritance diagram for mod_myobject_advanced:

Collaboration diagram for mod_myobject_advanced:

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

Detailed Description

Class to manage the Advanced numbering rule for MyObject.

Definition at line 35 of file mod_myobject_advanced.php.

Member Function Documentation

getExample()

mod_myobject_advanced::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefMyObject.

Definition at line 97 of file mod_myobject_advanced.php.

getNextValue()

mod_myobject_advanced::getNextValue

(

$object

)

Return next free value.

Parameters

Object

$object

Object we need next value for

Returns

string Value if KO, <0 if KO

Reimplemented from ModeleNumRefMyObject.

Definition at line 126 of file mod_myobject_advanced.php.

info()

mod_myobject_advanced::info

(

)

Returns the description of the numbering model.

Returns

string Descriptive text

Reimplemented from ModeleNumRefMyObject.

Definition at line 59 of file mod_myobject_advanced.php.

---

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

• htdocs/modulebuilder/template/core/modules/mymodule/mod_myobject_advanced.php