ModeleNumRefFactures Class Reference

Parent class of invoice reference numbering templates. More...

Inheritance diagram for ModeleNumRefFactures:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	info ()
	Returns the default description of the numbering pattern.
	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, $invoice, $mode='next')
	Renvoi prochaine valeur attribuee.
	getVersion ()
	Renvoi version du modele de numerotation.

Detailed Description

Parent class of invoice reference numbering templates.

Definition at line 254 of file modules_facture.php.

Member Function Documentation

canBeActivated()

ModeleNumRefFactures::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 in mod_facture_mars, and mod_facture_terre.

Definition at line 304 of file modules_facture.php.

getExample()

ModeleNumRefFactures::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented in mod_facture_mars, mod_facture_mercure, and mod_facture_terre.

Definition at line 291 of file modules_facture.php.

getNextValue()

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

Renvoi prochaine valeur attribuee.

Parameters

Societe	$objsoc	Objet societe
Facture	$invoice	Objet facture
string	$mode	'next' for next value or 'last' for last value

Returns

string Value

Reimplemented in mod_facture_mars, mod_facture_mercure, and mod_facture_terre.

Definition at line 317 of file modules_facture.php.

getVersion()

ModeleNumRefFactures::getVersion

(

)

Renvoi version du modele de numerotation.

Returns

string Valeur

Definition at line 328 of file modules_facture.php.

info()

ModeleNumRefFactures::info

(

)

Returns the default description of the numbering pattern.

Returns

string Descriptive text

Reimplemented in mod_facture_mars, mod_facture_mercure, and mod_facture_terre.

Definition at line 279 of file modules_facture.php.

isEnabled()

ModeleNumRefFactures::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 269 of file modules_facture.php.

---

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

• dolibarr_18.0/htdocs/core/modules/facture/modules_facture.php