mod_commande_marbre Class Reference

Class to manage Sales Order numbering rules Marbre. More...

Inheritance diagram for mod_commande_marbre:

Collaboration diagram for mod_commande_marbre:

Public Member Functions
	__construct ()
	Constructor.
	info ()
	Return description of numbering module.
	getExample ()
	Return an example of numbering.
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($objsoc, $object)
	Return next free value.
	commande_get_num ($objsoc, $objforref)
	Return next free value.
Public Member Functions inherited from ModeleNumRefCommandes
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage Sales Order numbering rules Marbre.

Definition at line 30 of file mod_commande_marbre.php.

Member Function Documentation

canBeActivated()

mod_commande_marbre::canBeActivated

(

)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns

boolean false if conflict, true if ok

Reimplemented from ModeleNumRefCommandes.

Definition at line 92 of file mod_commande_marbre.php.

commande_get_num()

mod_commande_marbre::commande_get_num	(		$objsoc,
			$objforref )

Return next free value.

Parameters

Societe	$objsoc	Object third party
string	$objforref	Object for number to search

Returns

string Next free value

Definition at line 176 of file mod_commande_marbre.php.

References getNextValue().

getExample()

mod_commande_marbre::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefCommandes.

Definition at line 80 of file mod_commande_marbre.php.

getNextValue()

mod_commande_marbre::getNextValue	(		$objsoc,
			$object )

Return next free value.

Parameters

Societe	$objsoc	Object thirdparty
Object	$object	Object we need next value for

Returns

string Value if KO, <0 if KO

Reimplemented from ModeleNumRefCommandes.

Definition at line 129 of file mod_commande_marbre.php.

References dol_syslog().

Referenced by commande_get_num().

info()

mod_commande_marbre::info

(

)

Return description of numbering module.

Returns

string Text with description

Reimplemented from ModeleNumRefCommandes.

Definition at line 68 of file mod_commande_marbre.php.

---

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

• dolibarr_18.0/htdocs/core/modules/commande/mod_commande_marbre.php