dolibarr 21.0.0-alpha
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 ($langs)
 Return default description of numbering model.
 
 getExample ()
 Return numbering example.
 
 canBeActivated ($object)
 Test if existing numbers make problems with numbering.
 
 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.
 
 getVersion ()
 Returns version of numbering module.
 

Detailed Description

Class to manage expedition numbering rules Safor.

Definition at line 31 of file mod_expedition_safor.php.

Member Function Documentation

◆ canBeActivated()

mod_expedition_safor::canBeActivated ( $object)

Test if existing numbers make problems with numbering.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 89 of file mod_expedition_safor.php.

◆ getExample()

mod_expedition_safor::getExample ( )

Return numbering example.

Returns
string Example

Reimplemented from ModelNumRefExpedition.

Definition at line 77 of file mod_expedition_safor.php.

◆ getNextValue()

mod_expedition_safor::getNextValue ( $objsoc,
$shipment )

Return next value.

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

Reimplemented from ModelNumRefExpedition.

Definition at line 126 of file mod_expedition_safor.php.

References dol_print_date(), and dol_syslog().

◆ info()

mod_expedition_safor::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 65 of file mod_expedition_safor.php.


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