dolibarr  21.0.0-alpha
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 ($langs)
 Returns the description of the numbering model. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ($object)
 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 CommonNumRefGenerator
 getNom ($langs)
 Return model name. More...
 
 getName ($langs)
 Return model name. More...
 
 isEnabled ()
 Return if a module can be used or not. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage invoice numbering rules Mars.

Definition at line 33 of file mod_facture_mars.php.

Member Function Documentation

◆ canBeActivated()

mod_facture_mars::canBeActivated (   $object)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 104 of file mod_facture_mars.php.

◆ getExample()

mod_facture_mars::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 92 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|int Value if OK, 0 if KO

Definition at line 167 of file mod_facture_mars.php.

◆ getNumRef()

mod_facture_mars::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 Next free value
Deprecated:
see getNextValue

Definition at line 253 of file mod_facture_mars.php.

◆ info()

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


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