dolibarr 18.0.6
ModeleNumRefSuppliersInvoices Class Reference

Parent Class of numbering models of suppliers invoices references. More...

Inheritance diagram for ModeleNumRefSuppliersInvoices:

Public Member Functions

 isEnabled ()
 Return if a model can be used or not.
 
 info ()
 Returns the default description of the model numbering.
 
 getExample ()
 Returns a numbering example.
 
 canBeActivated ()
 Tests if the numbers already in force in the database do not cause conflicts that would prevent this numbering.
 
 getNextValue ($objsoc, $object, $mode='next')
 Returns next value assigned.
 
 getVersion ()
 Returns version of the model numbering.
 

Detailed Description

Parent Class of numbering models of suppliers invoices references.

Definition at line 67 of file modules_facturefournisseur.php.

Member Function Documentation

◆ canBeActivated()

ModeleNumRefSuppliersInvoices::canBeActivated ( )

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

Returns
boolean false if conflict, true if ok

Reimplemented in mod_facture_fournisseur_cactus.

Definition at line 112 of file modules_facturefournisseur.php.

◆ getExample()

ModeleNumRefSuppliersInvoices::getExample ( )

Returns a numbering example.

Returns
string Example

Reimplemented in mod_facture_fournisseur_cactus, and mod_facture_fournisseur_tulip.

Definition at line 101 of file modules_facturefournisseur.php.

◆ getNextValue()

ModeleNumRefSuppliersInvoices::getNextValue ( $objsoc,
$object,
$mode = 'next' )

Returns next value assigned.

Parameters
Societe$objsocObject third party
Object$objectObject
string$mode'next' for next value or 'last' for last value
Returns
string Value if OK, 0 if KO

Reimplemented in mod_facture_fournisseur_cactus, and mod_facture_fournisseur_tulip.

Definition at line 124 of file modules_facturefournisseur.php.

◆ getVersion()

ModeleNumRefSuppliersInvoices::getVersion ( )

Returns version of the model numbering.

Returns
string Value

Definition at line 134 of file modules_facturefournisseur.php.

◆ info()

ModeleNumRefSuppliersInvoices::info ( )

Returns the default description of the model numbering.

Returns
string Description Text

Reimplemented in mod_facture_fournisseur_cactus, and mod_facture_fournisseur_tulip.

Definition at line 90 of file modules_facturefournisseur.php.

◆ isEnabled()

ModeleNumRefSuppliersInvoices::isEnabled ( )

Return if a model can be used or not.

Returns
boolean true if model can be used

Definition at line 81 of file modules_facturefournisseur.php.


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