dolibarr  19.0.0-dev
Public Member Functions | List of all members
ModelNumRefExpedition Class Reference

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

Inheritance diagram for ModelNumRefExpedition:
Inheritance graph
[legend]

Public Member Functions

 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...
 

Detailed Description

Parent Class of numbering models of sending receipts references.

Definition at line 70 of file modules_expedition.php.

Member Function Documentation

◆ canBeActivated()

ModelNumRefExpedition::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflict, true if ok

Reimplemented in mod_expedition_safor.

Definition at line 118 of file modules_expedition.php.

◆ getExample()

ModelNumRefExpedition::getExample ( )

Returns numbering example.

Returns
string Example

Reimplemented in mod_expedition_safor, and mod_expedition_ribera.

Definition at line 106 of file modules_expedition.php.

◆ getNextValue()

ModelNumRefExpedition::getNextValue (   $objsoc,
  $shipment 
)

Returns next value assigned.

Parameters
Societe$objsocThird party object
Object$shipmentShipment object
Returns
string Value

Reimplemented in mod_expedition_safor, and mod_expedition_ribera.

Definition at line 130 of file modules_expedition.php.

◆ getVersion()

ModelNumRefExpedition::getVersion ( )

Returns version of the numbering model.

Returns
string Value

Definition at line 141 of file modules_expedition.php.

◆ info()

ModelNumRefExpedition::info ( )

Return default description of numbering model.

Returns
string text description

Reimplemented in mod_expedition_safor, and mod_expedition_ribera.

Definition at line 94 of file modules_expedition.php.

◆ isEnabled()

ModelNumRefExpedition::isEnabled ( )

Return if a model can be used or not.

Returns
boolean true if model can be used

Definition at line 84 of file modules_expedition.php.


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