dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
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 ()
 Renvoi la description du modele de numerotation. More...
 
 getExample ()
 Return an example of number value. More...
 
 getNextValue ($objsoc, $invoice, $mode='next')
 Return next value. More...
 
 getNumRef ($objsoc, $objforref, $mode='next')
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefFactures
 isEnabled ()
 Return if a module can be used or not. More...
 
 info ()
 Renvoi la description par defaut du modele de numerotation. More...
 
 getExample ()
 Renvoi un exemple de numerotation. More...
 
 canBeActivated ()
 Test si les numeros deja en vigueur dans la base ne provoquent pas de conflits qui empecheraient cette numerotation de fonctionner. More...
 
 getNextValue ($objsoc, $facture)
 Renvoi prochaine valeur attribuee. More...
 
 getVersion ()
 Renvoi version du modele de numerotation. More...
 

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

Detailed Description

Class of numbering module Mercure for invoices.

Definition at line 34 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 111 of file mod_facture_mercure.php.

◆ getNextValue()

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

Return next value.

Parameters
Societe$objsocObject third party
Facture$invoiceObject invoice
string$mode'next' for next value or 'last' for last value
Returns
string Value if OK, 0 if KO

Definition at line 138 of file mod_facture_mercure.php.

◆ getNumRef()

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

Return next free value.

Parameters
Societe$objsocObject third party
string$objforrefObject for number to search
string$mode'next' for next value or 'last' for last value
Returns
string Next free value

Definition at line 185 of file mod_facture_mercure.php.

◆ info()

mod_facture_mercure::info ( )

Renvoi la description du modele de numerotation.

Returns
string Texte descripif

Definition at line 53 of file mod_facture_mercure.php.


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