mod_project_universal Class Reference

Class to manage the numbering module Universal for project references. More...

Inheritance diagram for mod_project_universal:

Collaboration diagram for mod_project_universal:

Public Member Functions
	info ($langs)
	Returns the description of the numbering model.
	getExample ()
	Return an example of numbering.
	getNextValue ($objsoc, $project)
	Return next value.
	project_get_num ($objsoc=0, $project='')
	Return next reference not yet used as a reference.
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.
	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 numbering module Universal for project references.

Definition at line 31 of file mod_project_universal.php.

Member Function Documentation

getExample()

mod_project_universal::getExample

(

)

Return an example of numbering.

Returns

string Example

Definition at line 109 of file mod_project_universal.php.

References getNextValue().

getNextValue()

mod_project_universal::getNextValue	(		$objsoc,
			$project )

Return next value.

Parameters

Societe	$objsoc	Object third party
Project	$project	Object project

Returns

string Value if OK, 0 if KO

Definition at line 131 of file mod_project_universal.php.

References dol_now(), get_next_value(), getDolGlobalString(), and getEntity().

Referenced by getExample(), and project_get_num().

info()

mod_project_universal::info

(

$langs

)

Returns the description of the numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 68 of file mod_project_universal.php.

References getDolGlobalString().

project_get_num()

mod_project_universal::project_get_num	(		$objsoc = 0,
			$project = '' )

Return next reference not yet used as a reference.

Parameters

Societe	$objsoc	Object third party
Project	$project	Object project

Returns

string Next not used reference

Definition at line 163 of file mod_project_universal.php.

References getNextValue().

---

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

• dolibarr_19.0/htdocs/core/modules/project/mod_project_universal.php