dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
mod_facture_fournisseur_cactus Class Reference

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

+ Inheritance diagram for mod_facture_fournisseur_cactus:
+ Collaboration diagram for mod_facture_fournisseur_cactus:

Public Member Functions

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

Public Attributes

 $version = 'dolibarr'
 Dolibarr version of the loaded document string.
 

Detailed Description

Cactus Class of numbering models of suppliers invoices references.

Definition at line 34 of file mod_facture_fournisseur_cactus.php.

Member Function Documentation

◆ canBeActivated()

mod_facture_fournisseur_cactus::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

Definition at line 95 of file mod_facture_fournisseur_cactus.php.

◆ getExample()

mod_facture_fournisseur_cactus::getExample ( )

Returns a numbering example.

Returns
string Example

Definition at line 84 of file mod_facture_fournisseur_cactus.php.

◆ getNextValue()

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

Return next value.

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

Definition at line 173 of file mod_facture_fournisseur_cactus.php.

◆ getNumRef()

mod_facture_fournisseur_cactus::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 246 of file mod_facture_fournisseur_cactus.php.

◆ info()

mod_facture_fournisseur_cactus::info ( )

Return description of numbering model.

Returns
string Text with description

Definition at line 71 of file mod_facture_fournisseur_cactus.php.


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