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 ($langs)
	Return default description of numbering model.
	getExample ()
	Return numbering example.
	getNextValue ($objsoc, $shipment)
	Return next value.
	expedition_get_num ($objsoc, $objforref)
	Return next free value.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name TODO Replace with getName()
	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 to manage expedition numbering rules Ribera.

Definition at line 31 of file mod_expedition_ribera.php.

Member Function Documentation

expedition_get_num()

mod_expedition_ribera::expedition_get_num	(		$objsoc,
			$objforref )

Return next free value.

Parameters

Societe	$objsoc	Third party object
Object	$objforref	Shipment object

Returns

string Next free value

Definition at line 151 of file mod_expedition_ribera.php.

References getNextValue().

getExample()

mod_expedition_ribera::getExample

(

)

Return numbering example.

Returns

string Example

Definition at line 98 of file mod_expedition_ribera.php.

References getNextValue().

getNextValue()

mod_expedition_ribera::getNextValue	(		$objsoc,
			$shipment )

Return next value.

Parameters

Societe	$objsoc	Third party object
Object	$shipment	Shipment object

Returns

string Value if OK, 0 if KO

Definition at line 123 of file mod_expedition_ribera.php.

References get_next_value(), and getDolGlobalString().

Referenced by expedition_get_num(), and getExample().

info()

mod_expedition_ribera::info

(

$langs

)

Return default description of numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 62 of file mod_expedition_ribera.php.

References getDolGlobalString().

---

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

• dolibarr_19.0/htdocs/core/modules/expedition/mod_expedition_ribera.php