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

Parent class for all contract numbering modules. More...

+ Inheritance diagram for ModelNumRefContracts:

Public Member Functions

 isEnabled ()
 Return if a module can be used or not. More...
 
 info ()
 Return default description of numbering model. More...
 
 getExample ()
 Return numbering example. More...
 
 canBeActivated ()
 Test if existing numbers make problems with numbering. More...
 
 getNextValue ($objsoc, $contract)
 Return next value. More...
 
 getVersion ()
 Return numbering version module. More...
 

Detailed Description

Parent class for all contract numbering modules.

Definition at line 68 of file modules_contract.php.

Member Function Documentation

ModelNumRefContracts::canBeActivated ( )

Test if existing numbers make problems with numbering.

Returns
boolean false if conflict, true if ok

Definition at line 111 of file modules_contract.php.

ModelNumRefContracts::getExample ( )

Return numbering example.

Returns
string Example

Definition at line 99 of file modules_contract.php.

ModelNumRefContracts::getNextValue (   $objsoc,
  $contract 
)

Return next value.

Parameters
Societe$objsocthird party object
Object$contractcontract object
Returns
string Value

Definition at line 123 of file modules_contract.php.

ModelNumRefContracts::getVersion ( )

Return numbering version module.

Returns
string Value

Definition at line 134 of file modules_contract.php.

ModelNumRefContracts::info ( )

Return default description of numbering model.

Returns
string text description

Definition at line 87 of file modules_contract.php.

ModelNumRefContracts::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 77 of file modules_contract.php.


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