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.
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.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the numbering module Simple for project references.

Definition at line 34 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

CommonObject

$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 93 of file mod_project_simple.php.

getExample()

mod_project_simple::getExample

(

)

Return an example of numbering module values.

Returns

string Example

Reimplemented from ModeleNumRefProjects.

Definition at line 80 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|int<-1,0> Value if OK, 0 if KO

Reimplemented from ModeleNumRefProjects.

Definition at line 130 of file mod_project_simple.php.

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

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

---

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

• dolibarr_dev/htdocs/core/modules/project/mod_project_simple.php