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 ($langs)
	Returns the description of the numbering model.
	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.
	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

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

Definition at line 99 of file mod_myobject_advanced.php.

References $object, and getNextValue().

getNextValue()

mod_myobject_advanced::getNextValue

(

$object

)

Return next free value.

Parameters

Object

$object

Object we need next value for

Returns

string|int Next value if OK, 0 if KO

Definition at line 128 of file mod_myobject_advanced.php.

References $object, get_next_value(), and getDolGlobalString().

Referenced by getExample().

info()

mod_myobject_advanced::info

(

$langs

)

Returns the description of the numbering model.

Parameters

Translate

$langs

Translate Object

Returns

string Text with description

Reimplemented from CommonNumRefGenerator.

Definition at line 60 of file mod_myobject_advanced.php.

References getDolGlobalString().

---

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

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