dolibarr 20.0.2
mod_delivery_saphir Class Reference

Class du modele de numerotation de reference de livraison Saphir. More...

Inheritance diagram for mod_delivery_saphir:
Collaboration diagram for mod_delivery_saphir:

Public Member Functions

 info ($langs)
 Returns the description of the numbering model.
 
 getExample ()
 Return an example of number.
 
 getNextValue ($objsoc, $object)
 Return next value.
 
 getNumRef ($objsoc, $objforref)
 Return next free 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 du modele de numerotation de reference de livraison Saphir.

Definition at line 33 of file mod_delivery_saphir.php.

Member Function Documentation

◆ getExample()

mod_delivery_saphir::getExample ( )

Return an example of number.

Returns
string Example

Definition at line 106 of file mod_delivery_saphir.php.

References getNextValue().

◆ getNextValue()

mod_delivery_saphir::getNextValue ( $objsoc,
$object )

Return next value.

Parameters
Societe$objsocObject third party
Delivery$objectObject delivery
Returns
string|int Value if OK, 0 if KO

Definition at line 129 of file mod_delivery_saphir.php.

References $object, get_next_value(), and getDolGlobalString().

Referenced by getExample(), and getNumRef().

◆ getNumRef()

mod_delivery_saphir::getNumRef ( $objsoc,
$objforref )

Return next free value.

Parameters
Societe$objsocObject third party
Delivery$objforrefObject for number to search
Returns
string|int Next free value, 0 if KO
Deprecated
see getNextValue

Definition at line 157 of file mod_delivery_saphir.php.

References getNextValue().

◆ info()

mod_delivery_saphir::info ( $langs)

Returns the description of the numbering model.

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

Reimplemented from CommonNumRefGenerator.

Definition at line 65 of file mod_delivery_saphir.php.

References getDolGlobalString().


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