ModeleNumRefPayments Class Reference

Payment numbering references mother class. More...

Inheritance diagram for ModeleNumRefPayments:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not. More...
	info ()
	Return the default description of numbering module. More...
	getExample ()
	Return numbering example. More...
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
	getNextValue ($objsoc, $object)
	Returns the next value. More...
	getVersion ()
	Returns the module numbering version. More...

Detailed Description

Payment numbering references mother class.

Definition at line 24 of file modules_payment.php.

Member Function Documentation

canBeActivated()

ModeleNumRefPayments::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_payment_cicada.

Definition at line 71 of file modules_payment.php.

getExample()

ModeleNumRefPayments::getExample

(

)

Return numbering example.

Returns

string Example

Reimplemented in mod_payment_cicada, and mod_payment_ant.

Definition at line 58 of file modules_payment.php.

getNextValue()

ModeleNumRefPayments::getNextValue	(		$objsoc,
			$object
	)

Returns the next value.

Parameters

Societe	$objsoc	Object thirdparty
Object	$object	Object we need next value for

Returns

string Valeur

Reimplemented in mod_payment_cicada, and mod_payment_ant.

Definition at line 83 of file modules_payment.php.

getVersion()

ModeleNumRefPayments::getVersion

(

)

Returns the module numbering version.

Returns

string Value

Definition at line 94 of file modules_payment.php.

info()

ModeleNumRefPayments::info

(

)

Return the default description of numbering module.

Returns

string Descriptive text

Reimplemented in mod_payment_cicada, and mod_payment_ant.

Definition at line 46 of file modules_payment.php.

isEnabled()

ModeleNumRefPayments::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 36 of file modules_payment.php.

---

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

• htdocs/core/modules/payment/modules_payment.php