ModeleNumRefWorkstation Class Reference

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

Inheritance diagram for ModeleNumRefWorkstation:

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 Workstation.

Definition at line 68 of file modules_workstation.php.

Member Function Documentation

canBeActivated()

ModeleNumRefWorkstation::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_workstation_standard.

Definition at line 119 of file modules_workstation.php.

getExample()

ModeleNumRefWorkstation::getExample

(

)

Returns an example of numbering.

Returns

string Example

Reimplemented in mod_workstation_advanced, and mod_workstation_standard.

Definition at line 105 of file modules_workstation.php.

getNextValue()

ModeleNumRefWorkstation::getNextValue

(

$object

)

Returns next assigned value.

Parameters

Object

$object

Object we need next value for

Returns

string Valeur

Reimplemented in mod_workstation_advanced, and mod_workstation_standard.

Definition at line 130 of file modules_workstation.php.

getVersion()

ModeleNumRefWorkstation::getVersion

(

)

Returns version of numbering module.

Returns

string Valeur

Definition at line 141 of file modules_workstation.php.

info()

ModeleNumRefWorkstation::info

(

)

Returns the default description of the numbering template.

Returns

string Descriptive text

Reimplemented in mod_workstation_advanced, and mod_workstation_standard.

Definition at line 93 of file modules_workstation.php.

isEnabled()

ModeleNumRefWorkstation::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 83 of file modules_workstation.php.

---

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

• dolibarr_18.0/htdocs/core/modules/workstation/modules_workstation.php