ModelNumRefExpedition Class Reference

Parent Class of numbering models of sending receipts references. More...

Inheritance diagram for ModelNumRefExpedition:

Public Member Functions
	isEnabled ()
	Return if a model can be used or not.
	info ()
	Return default description of numbering model.
	getExample ()
	Returns numbering example.
	canBeActivated ()
	Test if existing numbers make problems with numbering.
	getNextValue ($objsoc, $shipment)
	Returns next value assigned.
	getVersion ()
	Returns version of the numbering model.

Detailed Description

Parent Class of numbering models of sending receipts references.

Definition at line 70 of file modules_expedition.php.

Member Function Documentation

canBeActivated()

ModelNumRefExpedition::canBeActivated

(

)

Test if existing numbers make problems with numbering.

Returns

boolean false if conflict, true if ok

Reimplemented in mod_expedition_safor.

Definition at line 118 of file modules_expedition.php.

getExample()

ModelNumRefExpedition::getExample

(

)

Returns numbering example.

Returns

string Example

Reimplemented in mod_expedition_ribera, and mod_expedition_safor.

Definition at line 106 of file modules_expedition.php.

getNextValue()

ModelNumRefExpedition::getNextValue	(		$objsoc,
			$shipment )

Returns next value assigned.

Parameters

Societe	$objsoc	Third party object
Object	$shipment	Shipment object

Returns

string Value

Reimplemented in mod_expedition_ribera, and mod_expedition_safor.

Definition at line 130 of file modules_expedition.php.

getVersion()

ModelNumRefExpedition::getVersion

(

)

Returns version of the numbering model.

Returns

string Value

Definition at line 141 of file modules_expedition.php.

info()

ModelNumRefExpedition::info

(

)

Return default description of numbering model.

Returns

string text description

Reimplemented in mod_expedition_ribera, and mod_expedition_safor.

Definition at line 94 of file modules_expedition.php.

isEnabled()

ModelNumRefExpedition::isEnabled

(

)

Return if a model can be used or not.

Returns

boolean true if model can be used

Definition at line 84 of file modules_expedition.php.

---

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

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