dolibarr  16.0.5
Public Member Functions | List of all members
ModeleNumRefFactures Class Reference

Parent class of invoice reference numbering templates. More...

Inheritance diagram for ModeleNumRefFactures:
Inheritance graph
[legend]

Public Member Functions

 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, $invoice, $mode='next')
 Renvoi prochaine valeur attribuee. More...
 
 getVersion ()
 Renvoi version du modele de numerotation. More...
 

Detailed Description

Parent class of invoice reference numbering templates.

Definition at line 79 of file modules_facture.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefFactures::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 in mod_facture_terre, and mod_facture_mars.

Definition at line 126 of file modules_facture.php.

◆ getExample()

ModeleNumRefFactures::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented in mod_facture_mercure, mod_facture_terre, and mod_facture_mars.

Definition at line 113 of file modules_facture.php.

◆ getNextValue()

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

Renvoi prochaine valeur attribuee.

Parameters
Societe$objsocObjet societe
Facture$invoiceObjet facture
string$mode'next' for next value or 'last' for last value
Returns
string Value

Reimplemented in mod_facture_terre, mod_facture_mars, and mod_facture_mercure.

Definition at line 139 of file modules_facture.php.

◆ getVersion()

ModeleNumRefFactures::getVersion ( )

Renvoi version du modele de numerotation.

Returns
string Valeur

Definition at line 150 of file modules_facture.php.

◆ info()

ModeleNumRefFactures::info ( )

Renvoi la description par defaut du modele de numerotation.

Returns
string Texte descripif

Reimplemented in mod_facture_terre, mod_facture_mars, and mod_facture_mercure.

Definition at line 101 of file modules_facture.php.

◆ isEnabled()

ModeleNumRefFactures::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 91 of file modules_facture.php.


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