dolibarr 21.0.0-alpha
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.
 
- 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.
 
 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 33 of file mod_project_universal.php.

Member Function Documentation

◆ getExample()

mod_project_universal::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefProjects.

Definition at line 112 of file mod_project_universal.php.

References getNextValue().

◆ getNextValue()

mod_project_universal::getNextValue ( $objsoc,
$project )

Return next value.

Parameters
?Societe$objsocObject third party
Project$projectObject project
Returns
string|int<-1,0> Value if OK, 0 if KO

Reimplemented from ModeleNumRefProjects.

Definition at line 140 of file mod_project_universal.php.

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

Referenced by getExample().

◆ info()

mod_project_universal::info ( $langs)

Returns the description of the numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 70 of file mod_project_universal.php.

References getDolGlobalString().


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