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 ()
	Return description of numbering module. More...
	getExample ()
	Return an example of numbering module values. More...
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
	getNextValue ($objsoc, $project)
	Return next value. More...
	project_get_num ($objsoc=0, $project='')
	Return next reference not yet used as a reference. More...
Public Member Functions inherited from ModeleNumRefProjects
	isEnabled ()
	Return if a module can be used or not. More...
	getVersion ()
	Renvoi version du module numerotation. More...

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

(

)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns

boolean false if conflict, true if ok

Reimplemented from ModeleNumRefProjects.

Definition at line 89 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 77 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

Reimplemented from ModeleNumRefProjects.

Definition at line 126 of file mod_project_simple.php.

info()

mod_project_simple::info

(

)

Return description of numbering module.

Returns

string Text with description

Reimplemented from ModeleNumRefProjects.

Definition at line 65 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 174 of file mod_project_simple.php.

---

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

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