dolibarr  13.0.2
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:
+ Collaboration diagram for mod_facture_mars:

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...
 
 info ()
 Renvoi la description par defaut du modele de numerotation. 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, $facture)
 Renvoi prochaine valeur attribuee. 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

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

Definition at line 92 of file mod_facture_mars.php.

References $resql.

mod_facture_mars::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 81 of file mod_facture_mars.php.

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

Definition at line 152 of file mod_facture_mars.php.

References $resql, dol_print_error(), and dol_syslog().

Referenced by 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 221 of file mod_facture_mars.php.

References getNextValue().

mod_facture_mars::info ( )

Returns the description of the numbering model.

Returns
string Texte descripif

Definition at line 69 of file mod_facture_mars.php.


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