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 ()
	Return default description of numbering model.
	getExample ()
	Return numbering example.
	canBeActivated ()
	Test if existing numbers make problems with numbering.
	getNextValue ($objsoc, $shipment)
	Return next value.
	expedition_get_num ($objsoc, $objforref)
	Return next free value.
Public Member Functions inherited from ModelNumRefExpedition
	isEnabled ()
	Return if a model can be used or not.
	getVersion ()
	Returns version of the numbering model.

Detailed Description

Class to manage expedition numbering rules Safor.

Definition at line 29 of file mod_expedition_safor.php.

Member Function Documentation

canBeActivated()

mod_expedition_safor::canBeActivated

(

)

Test if existing numbers make problems with numbering.

Returns

boolean false if conflit, true if ok

Reimplemented from ModelNumRefExpedition.

Definition at line 85 of file mod_expedition_safor.php.

expedition_get_num()

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

References getNextValue().

getExample()

mod_expedition_safor::getExample

(

)

Return numbering example.

Returns

string Example

Reimplemented from ModelNumRefExpedition.

Definition at line 74 of file mod_expedition_safor.php.

getNextValue()

mod_expedition_safor::getNextValue	(		$objsoc,
			$shipment )

Return next value.

Parameters

Societe	$objsoc	Third party object
Object	$shipment	Shipment object

Returns

string Value if OK, 0 if KO

Reimplemented from ModelNumRefExpedition.

Definition at line 122 of file mod_expedition_safor.php.

References dol_syslog().

Referenced by expedition_get_num().

info()

mod_expedition_safor::info

(

)

Return default description of numbering model.

Returns

string text description

Reimplemented from ModelNumRefExpedition.

Definition at line 62 of file mod_expedition_safor.php.

---

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

• dolibarr_18.0/htdocs/core/modules/expedition/mod_expedition_safor.php