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.
	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 36 of file mod_facture_mercure.php.

Member Function Documentation

getExample()

mod_facture_mercure::getExample

(

)

Return an example of number value.

Returns

string Example

Definition at line 119 of file mod_facture_mercure.php.

References getNextValue().

getNextValue()

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

Return next value.

Parameters

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

Returns

string|int Value if OK, 0 if KO

Definition at line 145 of file mod_facture_mercure.php.

References 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 191 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 56 of file mod_facture_mercure.php.

References getDolGlobalString().

---

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

• dolibarr_20.0/htdocs/core/modules/facture/mod_facture_mercure.php