mod_member_simple Class Reference

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

Inheritance diagram for mod_member_simple:

Collaboration diagram for mod_member_simple:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering module values.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue ($objsoc, $object)
	Return next value.
Public Member Functions inherited from ModeleNumRefMembers
	getToolTip ($langs, $soc)
	Return description of module parameters.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name.
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage the numbering module Simple for member references.

Definition at line 33 of file mod_member_simple.php.

Member Function Documentation

canBeActivated()

mod_member_simple::canBeActivated

(

$object

)

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

Parameters

CommonObject

$object

Object we need next value for

Returns

boolean false if KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 85 of file mod_member_simple.php.

References $conf.

getExample()

mod_member_simple::getExample

(

)

Return an example of numbering module values.

Returns

string Example

Reimplemented from ModeleNumRefMembers.

Definition at line 72 of file mod_member_simple.php.

getNextValue()

mod_member_simple::getNextValue	(		$objsoc,
			$object )

Return next value.

Parameters

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

Returns

string|int<-1,0> Value if OK, -1 if KO

Reimplemented from ModeleNumRefMembers.

Definition at line 120 of file mod_member_simple.php.

References $conf, dol_syslog(), and getDolGlobalInt().

info()

mod_member_simple::info

(

$langs

)

Return description of numbering module.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 60 of file mod_member_simple.php.

---

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

• dolibarr_dev/htdocs/core/modules/member/mod_member_simple.php