dolibarr  19.0.0-dev
Public Member Functions | List of all members
mod_member_simple Class Reference

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

Inheritance diagram for mod_member_simple:
Inheritance graph
[legend]
Collaboration diagram for mod_member_simple:
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, $object)
 Return next value. More...
 
- Public Member Functions inherited from ModeleNumRefMembers
 isEnabled ()
 Return if a module can be used or not. More...
 
 getName ()
 Return name of module. More...
 
 getVersion ()
 Renvoi version du module numerotation. More...
 
 getToolTip ($langs, $soc)
 Return description of module parameters. More...
 

Detailed Description

Class to manage the numbering module Simple for member references.

Definition at line 32 of file mod_member_simple.php.

Member Function Documentation

◆ canBeActivated()

mod_member_simple::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 ModeleNumRefMembers.

Definition at line 91 of file mod_member_simple.php.

◆ getExample()

mod_member_simple::getExample ( )

Return an example of numbering module values.

Returns
string Example

Reimplemented from ModeleNumRefMembers.

Definition at line 79 of file mod_member_simple.php.

◆ getNextValue()

mod_member_simple::getNextValue (   $objsoc,
  $object 
)

Return next value.

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

Reimplemented from ModeleNumRefMembers.

Definition at line 126 of file mod_member_simple.php.

◆ info()

mod_member_simple::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefMembers.

Definition at line 67 of file mod_member_simple.php.


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