mod_member_custom Class Reference

Class to manage member report numbering rules Custom. More...

Inheritance diagram for mod_member_custom:

Collaboration diagram for mod_member_custom:

Public Member Functions
	info ($langs)
	Returns the description of the numbering model.
	getExample ()
	Return an example of numbering.
	getNextValue ($objsoc, $object)
	Return next free 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.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage member report numbering rules Custom.

Definition at line 32 of file mod_member_custom.php.

Member Function Documentation

getExample()

mod_member_custom::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefMembers.

Definition at line 108 of file mod_member_custom.php.

References getNextValue().

getNextValue()

mod_member_custom::getNextValue	(		$objsoc,
			$object )

Return next free value.

Parameters

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

Returns

string|int<-1,0> Next value if OK, -1 or 0 if KO

Reimplemented from ModeleNumRefMembers.

Definition at line 131 of file mod_member_custom.php.

References $object, dol_now(), get_next_value(), getDolGlobalString(), and getEntity().

Referenced by getExample().

info()

mod_member_custom::info

(

$langs

)

Returns the description of the numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 62 of file mod_member_custom.php.

References getDolGlobalString().

---

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

• dolibarr_23.0/htdocs/core/modules/member/mod_member_custom.php