mod_workstation_standard Class Reference

Class to manage the Standard numbering rule for Workstation. More...

Inheritance diagram for mod_workstation_standard:

Collaboration diagram for mod_workstation_standard:

Public Member Functions
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return 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)
	Return next free value.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name TODO Replace with getName()
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the Standard numbering rule for Workstation.

Definition at line 31 of file mod_workstation_standard.php.

Member Function Documentation

canBeActivated()

mod_workstation_standard::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 from CommonNumRefGenerator.

Definition at line 83 of file mod_workstation_standard.php.

getExample()

mod_workstation_standard::getExample

(

)

Return an example of numbering.

Returns

string Example

Definition at line 70 of file mod_workstation_standard.php.

getNextValue()

mod_workstation_standard::getNextValue

(

$object

)

Return next free value.

Parameters

Object

$object

Object we need next value for

Returns

string Value if KO, <0 if KO

Definition at line 121 of file mod_workstation_standard.php.

References dol_syslog().

info()

mod_workstation_standard::info

(

$langs

)

Return description of numbering module.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 58 of file mod_workstation_standard.php.

---

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

• dolibarr_19.0/htdocs/core/modules/workstation/mod_workstation_standard.php