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.
	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.
	getVersion ()
	Returns version of numbering module.

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

(

$object

)

Test if existing numbers make problems with numbering.

Parameters

Object

$object

Object we need next value for

Returns

boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 87 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 168 of file mod_expedition_safor.php.

References getNextValue().

getExample()

mod_expedition_safor::getExample

(

)

Return numbering example.

Returns

string Example

Definition at line 75 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

Definition at line 124 of file mod_expedition_safor.php.

References dol_print_date(), and dol_syslog().

Referenced by expedition_get_num().

info()

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

---

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

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