dolibarr  19.0.0-dev
Public Member Functions | List of all members
ModeleNumRefExpenseReport Class Reference

Parent class for numbering masks of expense reports. More...

Inheritance diagram for ModeleNumRefExpenseReport:
Inheritance graph
[legend]

Public Member Functions

 isEnabled ()
 Return if a model can be used or not. More...
 
 info ()
 Returns the default description of the numbering model. More...
 
 getExample ()
 Returns an example of numbering. More...
 
 canBeActivated ()
 Test whether the numbers already in force in the base do not cause conflicts that would prevent this numbering working. More...
 
 getNextValue ($object)
 Returns next assigned value. More...
 
 getVersion ()
 Returns the version of the numbering module. More...
 

Detailed Description

Parent class for numbering masks of expense reports.

Definition at line 111 of file modules_expensereport.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefExpenseReport::canBeActivated ( )

Test whether the numbers already in force in the base do not cause conflicts that would prevent this numbering working.

Returns
boolean false if conflict, true if ok

Reimplemented in mod_expensereport_jade.

Definition at line 160 of file modules_expensereport.php.

◆ getExample()

ModeleNumRefExpenseReport::getExample ( )

Returns an example of numbering.

Returns
string Example

Reimplemented in mod_expensereport_sand, and mod_expensereport_jade.

Definition at line 148 of file modules_expensereport.php.

◆ getNextValue()

ModeleNumRefExpenseReport::getNextValue (   $object)

Returns next assigned value.

Parameters
Object$objectObject we need next value for
Returns
string Value

Reimplemented in mod_expensereport_sand, and mod_expensereport_jade.

Definition at line 171 of file modules_expensereport.php.

◆ getVersion()

ModeleNumRefExpenseReport::getVersion ( )

Returns the version of the numbering module.

Returns
string Value

Definition at line 182 of file modules_expensereport.php.

◆ info()

ModeleNumRefExpenseReport::info ( )

Returns the default description of the numbering model.

Returns
string Descriptive text

Reimplemented in mod_expensereport_sand, and mod_expensereport_jade.

Definition at line 136 of file modules_expensereport.php.

◆ isEnabled()

ModeleNumRefExpenseReport::isEnabled ( )

Return if a model can be used or not.

Returns
boolean true if model can be used

Definition at line 126 of file modules_expensereport.php.


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