dolibarr  13.0.2
Public Member Functions | List of all members
mod_takepos_ref_simple Class Reference

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

+ Inheritance diagram for mod_takepos_ref_simple:
+ Collaboration diagram for mod_takepos_ref_simple:

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering module values. More...
 
 canBeActivated ()
 Test si les numeros deja en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner. More...
 
 getNextValue ($objsoc=null, $invoice=null, $mode= 'next')
 Return next value. More...
 
 getNumRef ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefTakepos
 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 ()
 Renvoi prochaine valeur attribuee. More...
 
 getVersion ()
 Renvoi version du modele de numerotation. More...
 

Detailed Description

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

Definition at line 32 of file mod_takepos_ref_simple.php.

Member Function Documentation

mod_takepos_ref_simple::canBeActivated ( )

Test si les numeros deja en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner.

Returns
boolean false si conflit, true si ok

Definition at line 85 of file mod_takepos_ref_simple.php.

References $resql.

mod_takepos_ref_simple::getExample ( )

Return an example of numbering module values.

Returns
string Example

Definition at line 74 of file mod_takepos_ref_simple.php.

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

Return next value.

Parameters
Societe$objsocObject third party
Facture$invoiceObject invoice
string$mode'next' for next value or 'last' for last value
Returns
string Next value

Definition at line 128 of file mod_takepos_ref_simple.php.

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

mod_takepos_ref_simple::getNumRef (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
Object$objforrefObject for number to search
Returns
string Next free value

Definition at line 190 of file mod_takepos_ref_simple.php.

References ModeleNumRefTakepos\getNextValue().

mod_takepos_ref_simple::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 62 of file mod_takepos_ref_simple.php.


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