dolibarr  17.0.3
Public Member Functions | List of all members
mod_task_simple Class Reference

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

Inheritance diagram for mod_task_simple:
Inheritance graph
[legend]
Collaboration diagram for mod_task_simple:
Collaboration graph
[legend]

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, $object)
 Return next value. More...
 
 task_get_num ($objsoc=0, $object='')
 Return next reference not yet used as a reference. More...
 
- Public Member Functions inherited from ModeleNumRefTask
 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_task_simple.php.

Member Function Documentation

◆ canBeActivated()

mod_task_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 ModeleNumRefTask.

Definition at line 89 of file mod_task_simple.php.

◆ getExample()

mod_task_simple::getExample ( )

Return an example of numbering module values.

Returns
string Example

Reimplemented from ModeleNumRefTask.

Definition at line 77 of file mod_task_simple.php.

◆ getNextValue()

mod_task_simple::getNextValue (   $objsoc,
  $object 
)

Return next value.

Parameters
Societe$objsocObject third party
Task$objectObject Task
Returns
string Value if OK, 0 if KO

Reimplemented from ModeleNumRefTask.

Definition at line 127 of file mod_task_simple.php.

◆ info()

mod_task_simple::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefTask.

Definition at line 65 of file mod_task_simple.php.

◆ task_get_num()

mod_task_simple::task_get_num (   $objsoc = 0,
  $object = '' 
)

Return next reference not yet used as a reference.

Parameters
Societe$objsocObject third party
Task$objectObject task
Returns
string Next not used reference

Definition at line 174 of file mod_task_simple.php.


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