dolibarr 21.0.0-alpha
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 ($langs)
 Return default description of numbering model.
 
 getExample ()
 Return numbering example.
 
 getNextValue ($objsoc, $shipment)
 Return next value.
 
- Public Member Functions inherited from CommonNumRefGenerator
 getNom ($langs)
 Return model name.
 
 getName ($langs)
 Return model name.
 
 isEnabled ()
 Return if a module can be used or not.
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage expedition numbering rules Ribera.

Definition at line 32 of file mod_expedition_ribera.php.

Member Function Documentation

◆ getExample()

mod_expedition_ribera::getExample ( )

Return numbering example.

Returns
string|int<0,0> Example

Reimplemented from ModelNumRefExpedition.

Definition at line 100 of file mod_expedition_ribera.php.

References getNextValue().

◆ getNextValue()

mod_expedition_ribera::getNextValue ( $objsoc,
$shipment )

Return next value.

Parameters
Societe$objsocThird party object
Expedition$shipmentShipment object
Returns
string|int<-1,0> Value if OK, 0 or -1 if KO

Reimplemented from ModelNumRefExpedition.

Definition at line 128 of file mod_expedition_ribera.php.

References get_next_value(), and getDolGlobalString().

Referenced by getExample().

◆ info()

mod_expedition_ribera::info ( $langs)

Return default description of numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 63 of file mod_expedition_ribera.php.

References getDolGlobalString().


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