mod_propale_marbre Class Reference

Class to manage business proposition rules Marbre. More...

Inheritance diagram for mod_propale_marbre:

Collaboration diagram for mod_propale_marbre:

Public Member Functions
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering module values.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($objsoc, $propal)
	Return next value.
	getNumRef ($objsoc, $objforref)
	Return next free value.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name.
	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 business proposition rules Marbre.

Definition at line 34 of file mod_propale_marbre.php.

Member Function Documentation

canBeActivated()

mod_propale_marbre::canBeActivated

(

$object

)

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

Parameters

CommonObject

$object

Object we need next value for

Returns

boolean false if KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 93 of file mod_propale_marbre.php.

getExample()

mod_propale_marbre::getExample

(

)

Return an example of numbering module values.

Returns

string Example

Definition at line 80 of file mod_propale_marbre.php.

getNextValue()

mod_propale_marbre::getNextValue	(		$objsoc,
			$propal )

Return next value.

Parameters

Societe	$objsoc	Object third party
Propal	$propal	Object commercial proposal

Returns

string|-1 Next value, -1 if KO

Definition at line 131 of file mod_propale_marbre.php.

References dol_print_date(), and dol_syslog().

Referenced by getNumRef().

getNumRef()

mod_propale_marbre::getNumRef	(		$objsoc,
			$objforref )

Return next free value.

Parameters

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

Returns

string|-1 Next free value, -1 if KO

Deprecated

see getNextValue

Definition at line 176 of file mod_propale_marbre.php.

References getNextValue().

info()

mod_propale_marbre::info

(

$langs

)

Return description of numbering module.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 68 of file mod_propale_marbre.php.

---

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

• dolibarr_dev/htdocs/core/modules/propale/mod_propale_marbre.php