ModeleNumRefPropales Class Reference

Parent class for numbering rules of proposals. More...

Inheritance diagram for ModeleNumRefPropales:

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

Detailed Description

Parent class for numbering rules of proposals.

Definition at line 70 of file modules_propale.php.

Member Function Documentation

canBeActivated()

ModeleNumRefPropales::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_propale_marbre.

Definition at line 117 of file modules_propale.php.

getExample()

ModeleNumRefPropales::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented in mod_propale_saphir, and mod_propale_marbre.

Definition at line 104 of file modules_propale.php.

getNextValue()

ModeleNumRefPropales::getNextValue	(		$objsoc,
			$propal
	)

Renvoi prochaine valeur attribuee.

Parameters

Societe	$objsoc	Object third party
Propal	$propal	Object commercial proposal

Returns

string Valeur

Reimplemented in mod_propale_saphir, and mod_propale_marbre.

Definition at line 129 of file modules_propale.php.

getVersion()

ModeleNumRefPropales::getVersion

(

)

Renvoi version du module numerotation.

Returns

string Valeur

Definition at line 140 of file modules_propale.php.

info()

ModeleNumRefPropales::info

(

)

Returns the default description of the numbering pattern.

Returns

string Descriptive text

Reimplemented in mod_propale_saphir, and mod_propale_marbre.

Definition at line 92 of file modules_propale.php.

isEnabled()

ModeleNumRefPropales::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 82 of file modules_propale.php.

---

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

• htdocs/core/modules/propale/modules_propale.php