dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_member_advanced Class Reference

Class to manage the numbering module Advanced for member references. More...

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

Public Member Functions

 __construct ()
 Constructor.
 
 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, $object)
 Return next value. More...
 
- Public Member Functions inherited from ModeleNumRefMembers
 getToolTip ($langs, $soc)
 Return description of module parameters. 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 the numbering module Advanced for member references.

Definition at line 33 of file mod_member_advanced.php.

Member Function Documentation

◆ canBeActivated()

mod_member_advanced::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 conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 85 of file mod_member_advanced.php.

◆ getExample()

mod_member_advanced::getExample ( )

Return an example of numbering module values.

Returns
string Example

Definition at line 72 of file mod_member_advanced.php.

◆ getNextValue()

mod_member_advanced::getNextValue (   $objsoc,
  $object 
)

Return next value.

Parameters
Societe$objsocObject third party
Adherent$objectObject we need next value for
Returns
string|-1 Value if OK, -1 if KO

Reimplemented from ModeleNumRefMembers.

Definition at line 122 of file mod_member_advanced.php.

◆ info()

mod_member_advanced::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 60 of file mod_member_advanced.php.


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