ModeleNumRefMembers Class Reference

Classe mere des modeles de numerotation des references de members. More...

Inheritance diagram for ModeleNumRefMembers:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	info ()
	Returns the default description of the numbering pattern.
	getName ()
	Return name of module.
	getExample ()
	Return an example of numbering.
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($objsoc, $object)
	Renvoi prochaine valeur attribuee.
	getVersion ()
	Renvoi version du module numerotation.
	getToolTip ($langs, $soc)
	Return description of module parameters.

Detailed Description

Classe mere des modeles de numerotation des references de members.

Definition at line 68 of file modules_member.class.php.

Member Function Documentation

canBeActivated()

ModeleNumRefMembers::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 in mod_member_advanced, and mod_member_simple.

Definition at line 134 of file modules_member.class.php.

getExample()

ModeleNumRefMembers::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented in mod_member_advanced, and mod_member_simple.

Definition at line 121 of file modules_member.class.php.

getName()

ModeleNumRefMembers::getName

(

)

Return name of module.

Returns

string Module name

Definition at line 111 of file modules_member.class.php.

Referenced by getToolTip().

getNextValue()

ModeleNumRefMembers::getNextValue	(		$objsoc,
			$object )

Renvoi prochaine valeur attribuee.

Parameters

Societe	$objsoc	Object third party
Object	$object	Object we need next value for

Returns

string Valeur

Reimplemented in mod_member_advanced, and mod_member_simple.

Definition at line 146 of file modules_member.class.php.

Referenced by getToolTip().

getToolTip()

ModeleNumRefMembers::getToolTip	(		$langs,
			$soc )

Return description of module parameters.

Parameters

Translate	$langs	Output language
Societe	$soc	Third party object

Returns

string HTML translated description

Definition at line 182 of file modules_member.class.php.

References getName(), getNextValue(), getVersion(), and yn().

getVersion()

ModeleNumRefMembers::getVersion

(

)

Renvoi version du module numerotation.

Returns

string Valeur

Definition at line 157 of file modules_member.class.php.

Referenced by getToolTip().

info()

ModeleNumRefMembers::info

(

)

Returns the default description of the numbering pattern.

Returns

string Descriptive text

Reimplemented in mod_member_advanced, and mod_member_simple.

Definition at line 99 of file modules_member.class.php.

isEnabled()

ModeleNumRefMembers::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 89 of file modules_member.class.php.

---

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

• dolibarr_18.0/htdocs/core/modules/member/modules_member.class.php