dolibarr  20.0.0-beta
Public Member Functions | List of all members
mod_facture_mercure Class Reference

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

Inheritance diagram for mod_facture_mercure:
Inheritance graph
[legend]
Collaboration diagram for mod_facture_mercure:
Collaboration graph
[legend]

Public Member Functions

 info ($langs)
 Returns the description of the numbering model. 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 CommonNumRefGenerator
 getNom ($langs)
 Return model name. More...
 
 getName ($langs)
 Return model name. More...
 
 isEnabled ()
 Return if a module can be used or not. More...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

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 114 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|0 Value if OK, 0 if KO

Definition at line 140 of file mod_facture_mercure.php.

◆ getNumRef()

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

Return next free value.

Parameters
Societe$objsocObject third party
Facture$objforrefObject for number to search
string$mode'next' for next value or 'last' for last value
Returns
string|0 Next free value, 0 if KO
Deprecated:
see getNextValue

Definition at line 186 of file mod_facture_mercure.php.

◆ info()

mod_facture_mercure::info (   $langs)

Returns the description of the numbering model.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 56 of file mod_facture_mercure.php.


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