mod_facture_mercure Class Reference

Class of numbering module Mercure for invoices. More...

Inheritance diagram for mod_facture_mercure:

Collaboration diagram for mod_facture_mercure:

Public Member Functions
	info ($langs)
	Returns the description of the numbering model.
	getExample ()
	Return an example of number value.
	getNextValue ($objsoc, $invoice, $mode='next')
	Return next value not used or last value used.
	getNumRef ($objsoc, $objforref, $mode='next')
	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.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class of numbering module Mercure for invoices.

Definition at line 38 of file mod_facture_mercure.php.

Member Function Documentation

getExample()

mod_facture_mercure::getExample

(

)

Return an example of number value.

Returns

string Example

Reimplemented from ModeleNumRefFactures.

Definition at line 137 of file mod_facture_mercure.php.

References $mysoc, and getNextValue().

getNextValue()

mod_facture_mercure::getNextValue	(		$objsoc,
			$invoice,
			$mode = 'next' )

Return next value not used or last value used.

Parameters

Societe	$objsoc	Object third party
?Facture	$invoice	Object invoice
string	$mode	'next' for next value or 'last' for last value

Returns

string|int<-1,0> Value if OK, <=0 if KO

Reimplemented from ModeleNumRefFactures.

Definition at line 163 of file mod_facture_mercure.php.

References $db, dol_now(), get_next_value(), getDolGlobalString(), and getEntity().

Referenced by getExample(), and getNumRef().

getNumRef()

mod_facture_mercure::getNumRef	(		$objsoc,
			$objforref,
			$mode = 'next' )

Return next free value.

Parameters

Societe	$objsoc	Object third party
Facture	$objforref	Object for number to search
string	$mode	'next' for next value or 'last' for last value

Returns

string|int Next free value, 0 if KO

Deprecated

see getNextValue

Definition at line 210 of file mod_facture_mercure.php.

References getNextValue().

info()

mod_facture_mercure::info

(

$langs

)

Returns the description of the numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 68 of file mod_facture_mercure.php.

References $db, and getDolGlobalString().

---

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

• dolibarr_dev/htdocs/core/modules/facture/mod_facture_mercure.php