dolibarr  17.0.4
Public Member Functions | List of all members
mod_propale_marbre Class Reference

Class to manage business proposition rules Marbre. More...

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

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering module values. More...
 
 canBeActivated ()
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getNextValue ($objsoc, $propal)
 Return next value. More...
 
 getNumRef ($objsoc, $objforref)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefPropales
 isEnabled ()
 Return if a module can be used or not. More...
 
 getVersion ()
 Renvoi version du module numerotation. More...
 

Detailed Description

Class to manage business proposition rules Marbre.

Definition at line 32 of file mod_propale_marbre.php.

Member Function Documentation

◆ canBeActivated()

mod_propale_marbre::canBeActivated ( )

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Returns
boolean false if conflict, true if ok

Reimplemented from ModeleNumRefPropales.

Definition at line 89 of file mod_propale_marbre.php.

◆ getExample()

mod_propale_marbre::getExample ( )

Return an example of numbering module values.

Returns
string Example

Reimplemented from ModeleNumRefPropales.

Definition at line 77 of file mod_propale_marbre.php.

◆ getNextValue()

mod_propale_marbre::getNextValue (   $objsoc,
  $propal 
)

Return next value.

Parameters
Societe$objsocObject third party
Propal$propalObject commercial proposal
Returns
string Next value

Reimplemented from ModeleNumRefPropales.

Definition at line 127 of file mod_propale_marbre.php.

◆ getNumRef()

mod_propale_marbre::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 171 of file mod_propale_marbre.php.

◆ info()

mod_propale_marbre::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefPropales.

Definition at line 65 of file mod_propale_marbre.php.


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