dolibarr  20.0.0-alpha
Public Member Functions | List of all members
mod_takepos_ref_universal Class Reference

Class to manage ref numbering of takepos cards with rule universal. More...

Inheritance diagram for mod_takepos_ref_universal:
Inheritance graph
[legend]
Collaboration diagram for mod_takepos_ref_universal:
Collaboration graph
[legend]

Public Member Functions

 info ($langs)
 return description of the numbering model More...
 
 getExample ()
 Return an example of numbering. More...
 
 getNextValue ($objsoc=null, $invoice=null, $mode='next')
 Return next free value. More...
 
 getNumRef ($objsoc, $objforref)
 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...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage ref numbering of takepos cards with rule universal.

Definition at line 36 of file mod_takepos_ref_universal.php.

Member Function Documentation

◆ getExample()

mod_takepos_ref_universal::getExample ( )

Return an example of numbering.

Returns
string Example

Definition at line 102 of file mod_takepos_ref_universal.php.

◆ getNextValue()

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

Return next free value.

Parameters
Societe$objsocObject thirdparty
Facture$invoiceObject invoice
string$mode'next' for next value or 'last' for last value
Returns
string|0 Next value if OK, 0 if KO

Definition at line 125 of file mod_takepos_ref_universal.php.

◆ getNumRef()

mod_takepos_ref_universal::getNumRef (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
Facture$objforrefObject for number to search
Returns
string Next free value
Deprecated:
see getNextValue

Definition at line 159 of file mod_takepos_ref_universal.php.

◆ info()

mod_takepos_ref_universal::info (   $langs)

return description of the numbering model

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 61 of file mod_takepos_ref_universal.php.


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