mod_payment_ant Class Reference

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

Inheritance diagram for mod_payment_ant:

Collaboration diagram for mod_payment_ant:

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.
	commande_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.
	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 customer payment numbering rules Ant.

Definition at line 32 of file mod_payment_ant.php.

Member Function Documentation

commande_get_num()

mod_payment_ant::commande_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, <=0 if KO

Definition at line 155 of file mod_payment_ant.php.

References getNextValue().

getExample()

mod_payment_ant::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefPayments.

Definition at line 105 of file mod_payment_ant.php.

References getNextValue().

getNextValue()

mod_payment_ant::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_ant.php.

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

Referenced by commande_get_num(), and getExample().

info()

mod_payment_ant::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 64 of file mod_payment_ant.php.

References getDolGlobalString().

---

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

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