mod_project_simple Class Reference

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

Inheritance diagram for mod_project_simple:

Collaboration diagram for mod_project_simple:

Public Member Functions
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering module values.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	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.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the numbering module Simple for project references.

Definition at line 32 of file mod_project_simple.php.

Member Function Documentation

canBeActivated()

mod_project_simple::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 KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 91 of file mod_project_simple.php.

getExample()

mod_project_simple::getExample

(

)

Return an example of numbering module values.

Returns

string Example

Definition at line 78 of file mod_project_simple.php.

getNextValue()

mod_project_simple::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 128 of file mod_project_simple.php.

References dol_now(), dol_print_date(), and dol_syslog().

Referenced by project_get_num().

info()

mod_project_simple::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 66 of file mod_project_simple.php.

project_get_num()

mod_project_simple::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 177 of file mod_project_simple.php.

References getNextValue().

---

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

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