dolibarr  17.0.4
Public Member Functions | List of all members
mod_reception_beryl Class Reference

Class to manage reception numbering rules Beryl. More...

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

Public Member Functions

 info ()
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ()
 Test if existing numbers make problems with numbering. More...
 
 getNextValue ($objsoc, $reception)
 Return next value. More...
 
 reception_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModelNumRefReception
 isEnabled ()
 Return if a model can be used or not. More...
 
 getVersion ()
 Returns version of the numbering model. More...
 

Detailed Description

Class to manage reception numbering rules Beryl.

Definition at line 29 of file mod_reception_beryl.php.

Member Function Documentation

◆ canBeActivated()

mod_reception_beryl::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflit, true if ok

Reimplemented from ModelNumRefReception.

Definition at line 65 of file mod_reception_beryl.php.

◆ getExample()

mod_reception_beryl::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefReception.

Definition at line 54 of file mod_reception_beryl.php.

◆ getNextValue()

mod_reception_beryl::getNextValue (   $objsoc,
  $reception 
)

Return next value.

Parameters
Societe$objsocThird party object
Object$receptionReception object
Returns
string Value if OK, 0 if KO

Reimplemented from ModelNumRefReception.

Definition at line 102 of file mod_reception_beryl.php.

◆ info()

mod_reception_beryl::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented from ModelNumRefReception.

Definition at line 42 of file mod_reception_beryl.php.

◆ reception_get_num()

mod_reception_beryl::reception_get_num (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocThird party object
Object$objforrefShipment object
Returns
string Next free value

Definition at line 146 of file mod_reception_beryl.php.


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