dolibarr  17.0.4
Public Member Functions | List of all members
mod_facture_mars Class Reference

Class to manage invoice numbering rules Mars. More...

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

Public Member Functions

 __construct ()
 Constructor.
 
 info ()
 Returns the description of the numbering model. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getNextValue ($objsoc, $invoice, $mode='next')
 Return next value not used or last value used. 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...
 
 getVersion ()
 Renvoi version du modele de numerotation. More...
 

Detailed Description

Class to manage invoice numbering rules Mars.

Definition at line 31 of file mod_facture_mars.php.

Member Function Documentation

◆ canBeActivated()

mod_facture_mars::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 from ModeleNumRefFactures.

Definition at line 100 of file mod_facture_mars.php.

◆ getExample()

mod_facture_mars::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefFactures.

Definition at line 89 of file mod_facture_mars.php.

◆ getNextValue()

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

Return next value not used or last value used.

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 163 of file mod_facture_mars.php.

◆ getNumRef()

mod_facture_mars::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 247 of file mod_facture_mars.php.

◆ info()

mod_facture_mars::info ( )

Returns the description of the numbering model.

Returns
string Texte descripif

Reimplemented from ModeleNumRefFactures.

Definition at line 77 of file mod_facture_mars.php.


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