dolibarr  7.0.0-beta
Public Member Functions | List of all members
mod_chequereceipt_mint Class Reference

Class to manage cheque receipts numbering rules Mint. More...

+ Inheritance diagram for mod_chequereceipt_mint:
+ Collaboration diagram for mod_chequereceipt_mint:

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Renvoi un exemple de numerotation. More...
 
 canBeActivated ()
 Test si les numeros deje en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner. More...
 
 getNextValue ($objsoc, $object)
 Return next free value. More...
 
 chequereceipt_get_num ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefChequeReceipts
 isEnabled ()
 Return if a module can be used or not. More...
 
 info ()
 Return the default description of numbering module. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ()
 Test if the existing numbers in the database do not cause conflicts that would prevent this numbering run. More...
 
 getNextValue ($objsoc, $object)
 Returns the next value. More...
 
 getVersion ()
 Returns the module numbering version. More...
 

Detailed Description

Class to manage cheque receipts numbering rules Mint.

Definition at line 30 of file mod_chequereceipt_mint.php.

Member Function Documentation

mod_chequereceipt_mint::canBeActivated ( )

Test si les numeros deje 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 67 of file mod_chequereceipt_mint.php.

References $resql.

mod_chequereceipt_mint::chequereceipt_get_num (   $objsoc,
  $objforref 
)

Return next free value.

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

Definition at line 145 of file mod_chequereceipt_mint.php.

References getNextValue().

mod_chequereceipt_mint::getExample ( )

Renvoi un exemple de numerotation.

Returns
string Example

Definition at line 55 of file mod_chequereceipt_mint.php.

mod_chequereceipt_mint::getNextValue (   $objsoc,
  $object 
)

Return next free value.

Parameters
Societe$objsocObject thirdparty
Object$objectObject we need next value for
Returns
string Value if KO, <0 if KO

Definition at line 102 of file mod_chequereceipt_mint.php.

References $resql, and dol_syslog().

Referenced by chequereceipt_get_num().

mod_chequereceipt_mint::info ( )

Return description of numbering module.

Returns
string Text with description

Definition at line 43 of file mod_chequereceipt_mint.php.


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