dolibarr 18.0.6
mod_expedition_ribera Class Reference

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

Inheritance diagram for mod_expedition_ribera:
Collaboration diagram for mod_expedition_ribera:

Public Member Functions

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

Detailed Description

Class to manage expedition numbering rules Ribera.

Definition at line 31 of file mod_expedition_ribera.php.

Member Function Documentation

◆ expedition_get_num()

mod_expedition_ribera::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 150 of file mod_expedition_ribera.php.

References getNextValue().

◆ getExample()

mod_expedition_ribera::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefExpedition.

Definition at line 97 of file mod_expedition_ribera.php.

References getNextValue().

◆ getNextValue()

mod_expedition_ribera::getNextValue ( $objsoc,
$shipment )

Return next value.

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

Reimplemented from ModelNumRefExpedition.

Definition at line 122 of file mod_expedition_ribera.php.

References get_next_value(), and getDolGlobalString().

Referenced by expedition_get_num(), and getExample().

◆ info()

mod_expedition_ribera::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented from ModelNumRefExpedition.

Definition at line 61 of file mod_expedition_ribera.php.

References getDolGlobalString().


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