dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
mod_expedition_safor Class Reference

Class to manage expedition numbering rules Safor. More...

+ Inheritance diagram for mod_expedition_safor:
+ Collaboration diagram for mod_expedition_safor:

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, $shipment)
 Return next value. More...
 
 expedition_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModelNumRefExpedition
 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, $shipment)
 Returns next value assigned. More...
 
 getVersion ()
 Returns version of the numbering model. More...
 

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

Detailed Description

Class to manage expedition numbering rules Safor.

Definition at line 29 of file mod_expedition_safor.php.

Member Function Documentation

◆ canBeActivated()

mod_expedition_safor::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflit, true if ok

Definition at line 85 of file mod_expedition_safor.php.

◆ expedition_get_num()

mod_expedition_safor::expedition_get_num (   $objsoc,
  $objforref 
)

Return next free value.

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

Definition at line 161 of file mod_expedition_safor.php.

References getNextValue().

◆ getExample()

mod_expedition_safor::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 74 of file mod_expedition_safor.php.

◆ getNextValue()

mod_expedition_safor::getNextValue (   $objsoc,
  $shipment 
)

Return next value.

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

Definition at line 120 of file mod_expedition_safor.php.

Referenced by expedition_get_num().

◆ info()

mod_expedition_safor::info ( )

Return default description of numbering model.

Returns
string text description

Definition at line 62 of file mod_expedition_safor.php.


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