dolibarr  7.0.0-beta
Public Member Functions | List of all members
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 ()
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. More...
 
 getNextValue ($objsoc, $shipment)
 Return next value. More...
 
 expedition_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModelNumRefExpedition
 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

Class to manage expedition numbering rules Ribera.

Definition at line 30 of file mod_expedition_ribera.php.

Member Function Documentation

mod_expedition_ribera::expedition_get_num (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocThird party object
Object$objforrefShipment object
Returns
string Next free value

Definition at line 131 of file mod_expedition_ribera.php.

References getNextValue().

mod_expedition_ribera::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 77 of file mod_expedition_ribera.php.

References getNextValue().

mod_expedition_ribera::getNextValue (   $objsoc,
  $shipment 
)

Return next value.

Parameters
Societe$objsocThird party object
Object$shipmentShipment object
Returns
string Value if OK, 0 if KO

Definition at line 103 of file mod_expedition_ribera.php.

References get_next_value().

Referenced by expedition_get_num(), and getExample().

mod_expedition_ribera::info ( )

Return default description of numbering model.

Returns
string text description

Definition at line 41 of file mod_expedition_ribera.php.

References $form.


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