dolibarr 21.0.0-alpha
ModelNumRefExpedition Class Reference

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

Inheritance diagram for ModelNumRefExpedition:
Collaboration diagram for ModelNumRefExpedition:

Public Member Functions

 getNextValue ($objsoc, $shipment)
 Return next value.
 
 getExample ()
 Return an example of numbering.
 
- 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.
 
 info ($langs)
 Returns the default description of the numbering template.
 
 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

Parent Class of numbering models of sending receipts references.

Definition at line 84 of file modules_expedition.php.

Member Function Documentation

◆ getExample()

ModelNumRefExpedition::getExample ( )
abstract

Return an example of numbering.

Returns
string Example

Reimplemented in mod_expedition_ribera, and mod_expedition_safor.

◆ getNextValue()

ModelNumRefExpedition::getNextValue ( $objsoc,
$shipment )
abstract

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 in mod_expedition_ribera, and mod_expedition_safor.


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