dolibarr  17.0.4
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 ()
 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 ModeleNumRefFactures
 isEnabled ()
 Return if a module can be used or not. More...
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Renvoi version du modele de numerotation. More...
 

Detailed Description

Class of numbering module Mercure for invoices.

Definition at line 35 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 112 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

Reimplemented from ModeleNumRefFactures.

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

◆ info()

mod_facture_mercure::info ( )

Returns the description of the numbering model.

Returns
string Texte descripif

Reimplemented from ModeleNumRefFactures.

Definition at line 54 of file mod_facture_mercure.php.


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