dolibarr  16.0.5
Public Member Functions | List of all members
ModelNumRefReception Class Reference

Parent Class of numbering models of sending receipts references. More...

Inheritance diagram for ModelNumRefReception:
Inheritance graph
[legend]

Public Member Functions

 isEnabled ()
 Return if a model can be used or not. More...
 
 info ()
 Return default description of numbering model. More...
 
 getExample ()
 Returns numbering example. More...
 
 canBeActivated ()
 Test if existing numbers make problems with numbering. More...
 
 getNextValue ($objsoc, $reception)
 Returns next value assigned. More...
 
 getVersion ()
 Returns version of the numbering model. More...
 

Detailed Description

Parent Class of numbering models of sending receipts references.

Definition at line 62 of file modules_reception.php.

Member Function Documentation

◆ canBeActivated()

ModelNumRefReception::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflit, true if ok

Reimplemented in mod_reception_beryl.

Definition at line 104 of file modules_reception.php.

◆ getExample()

ModelNumRefReception::getExample ( )

Returns numbering example.

Returns
string Example

Reimplemented in mod_reception_moonstone, and mod_reception_beryl.

Definition at line 92 of file modules_reception.php.

◆ getNextValue()

ModelNumRefReception::getNextValue (   $objsoc,
  $reception 
)

Returns next value assigned.

Parameters
Societe$objsocThird party object
Object$receptionReception object
Returns
string Value

Reimplemented in mod_reception_moonstone, and mod_reception_beryl.

Definition at line 116 of file modules_reception.php.

◆ getVersion()

ModelNumRefReception::getVersion ( )

Returns version of the numbering model.

Returns
string Value

Definition at line 127 of file modules_reception.php.

◆ info()

ModelNumRefReception::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented in mod_reception_beryl, and mod_reception_moonstone.

Definition at line 80 of file modules_reception.php.

◆ isEnabled()

ModelNumRefReception::isEnabled ( )

Return if a model can be used or not.

Returns
boolean true if model can be used

Definition at line 70 of file modules_reception.php.


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