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 ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering.
	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 free value.
	payment_get_num ($objsoc, $objforref)
	Return next free value.
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 customer payment numbering rules Cicada.

Definition at line 31 of file mod_payment_cicada.php.

Member Function Documentation

canBeActivated()

mod_payment_cicada::canBeActivated

(

$object

)

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

Parameters

Object

$object

Object we need next value for

Returns

boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 90 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 77 of file mod_payment_cicada.php.

getNextValue()

mod_payment_cicada::getNextValue	(		$objsoc,
			$object )

Return next free value.

Parameters

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

Returns

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

Reimplemented from ModeleNumRefPayments.

Definition at line 127 of file mod_payment_cicada.php.

References $object, dol_print_date(), and dol_syslog().

Referenced by payment_get_num().

info()

mod_payment_cicada::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 65 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
?Paiement	$objforref	Object for number to search

Returns

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

Definition at line 174 of file mod_payment_cicada.php.

References getNextValue().

---

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

• dolibarr_dev/htdocs/core/modules/payment/mod_payment_cicada.php