dolibarr  16.0.5
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:
Inheritance graph
[legend]
Collaboration diagram for mod_takepos_ref_simple:
Collaboration graph
[legend]

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...
 
 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

◆ canBeActivated()

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

Reimplemented from ModeleNumRefTakepos.

Definition at line 88 of file mod_takepos_ref_simple.php.

◆ getExample()

mod_takepos_ref_simple::getExample ( )

Return an example of numbering module values.

Returns
string Example.

Reimplemented from ModeleNumRefTakepos.

Definition at line 77 of file mod_takepos_ref_simple.php.

◆ getNextValue()

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

Return next value.

Note to increase perf of this numbering engine: ALTER TABLE llx_facture ADD COLUMN calculated_numrefonly INTEGER AS (CASE SUBSTRING(ref FROM 1 FOR 2) WHEN 'TC' THEN CAST(SUBSTRING(ref FROM 10) AS SIGNED) ELSE 0 END) PERSISTENT; ALTER TABLE llx_facture ADD INDEX calculated_numrefonly_idx (calculated_numrefonly);

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

Reimplemented from ModeleNumRefTakepos.

Definition at line 134 of file mod_takepos_ref_simple.php.

◆ getNumRef()

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 210 of file mod_takepos_ref_simple.php.

◆ info()

mod_takepos_ref_simple::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefTakepos.

Definition at line 62 of file mod_takepos_ref_simple.php.


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