mod_payment_cicada Class Reference

Class to manage customer payment numbering rules Cicada. More...

Inheritance diagram for mod_payment_cicada:

Collaboration diagram for mod_payment_cicada:

Public Member Functions
	info ()
	Return description of numbering 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)
	Return next free value.
	payment_get_num ($objsoc, $objforref)
	Return next free value.
Public Member Functions inherited from ModeleNumRefPayments
	isEnabled ()
	Return if a module can be used or not.
	getVersion ()
	Returns the module numbering version.

Detailed Description

Class to manage customer payment numbering rules Cicada.

Definition at line 30 of file mod_payment_cicada.php.

Member Function Documentation

canBeActivated()

mod_payment_cicada::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 from ModeleNumRefPayments.

Definition at line 87 of file mod_payment_cicada.php.

getExample()

mod_payment_cicada::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefPayments.

Definition at line 75 of file mod_payment_cicada.php.

getNextValue()

mod_payment_cicada::getNextValue	(		$objsoc,
			$object )

Return next free value.

Parameters

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

Returns

string Value if KO, <0 if KO

Reimplemented from ModeleNumRefPayments.

Definition at line 124 of file mod_payment_cicada.php.

References dol_syslog().

Referenced by payment_get_num().

info()

mod_payment_cicada::info

(

)

Return description of numbering module.

Returns

string Text with description

Reimplemented from ModeleNumRefPayments.

Definition at line 63 of file mod_payment_cicada.php.

payment_get_num()

mod_payment_cicada::payment_get_num	(		$objsoc,
			$objforref )

Return next free value.

Parameters

Societe	$objsoc	Object third party
string	$objforref	Object for number to search

Returns

string Next free value

Definition at line 171 of file mod_payment_cicada.php.

References getNextValue().

---

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

• dolibarr_18.0/htdocs/core/modules/payment/mod_payment_cicada.php