dolibarr  21.0.0-alpha
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 ($langs)
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering module values. More...
 
 canBeActivated ($object)
 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 CommonNumRefGenerator
 getNom ($langs)
 Return model name. More...
 
 getName ($langs)
 Return model name. More...
 
 isEnabled ()
 Return if a module can be used or not. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage business proposition rules Marbre.

Definition at line 34 of file mod_propale_marbre.php.

Member Function Documentation

◆ canBeActivated()

mod_propale_marbre::canBeActivated (   $object)

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

Parameters
CommonObject$objectObject we need next value for
Returns
boolean false if KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 93 of file mod_propale_marbre.php.

◆ getExample()

mod_propale_marbre::getExample ( )

Return an example of numbering module values.

Returns
string Example

Definition at line 80 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|-1 Next value, -1 if KO

Definition at line 131 of file mod_propale_marbre.php.

◆ getNumRef()

mod_propale_marbre::getNumRef (   $objsoc,
  $objforref 
)

Return next free value.

Parameters
Societe$objsocObject third party
Propal$objforrefObject for number to search
Returns
string|-1 Next free value, -1 if KO
Deprecated:
see getNextValue

Definition at line 176 of file mod_propale_marbre.php.

◆ info()

mod_propale_marbre::info (   $langs)

Return description of numbering module.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 68 of file mod_propale_marbre.php.


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