mod_facture_fournisseur_cactus Class Reference

Cactus Class of numbering models of suppliers invoices references. More...

Inheritance diagram for mod_facture_fournisseur_cactus:

Collaboration diagram for mod_facture_fournisseur_cactus:

Public Member Functions
	info ($langs)
	Return description of numbering model.
	getExample ()
	Returns a numbering example.
	canBeActivated ($object)
	Tests if the numbers already in the database do not cause conflicts that would prevent this numbering.
	getNextValue ($objsoc, $object, $mode='next')
	Return next value.
	getNumRef ($objsoc, $objforref, $mode='next')
	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

Cactus Class of numbering models of suppliers invoices references.

Definition at line 36 of file mod_facture_fournisseur_cactus.php.

Member Function Documentation

canBeActivated()

mod_facture_fournisseur_cactus::canBeActivated

(

$object

)

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

Parameters

CommonObject

$object

Object we need next value for

Returns

boolean false if KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 99 of file mod_facture_fournisseur_cactus.php.

getExample()

mod_facture_fournisseur_cactus::getExample

(

)

Returns a numbering example.

Returns

string Example

Reimplemented from ModeleNumRefSuppliersInvoices.

Definition at line 87 of file mod_facture_fournisseur_cactus.php.

getNextValue()

mod_facture_fournisseur_cactus::getNextValue	(		$objsoc,
			$object,
			$mode = 'next' )

Return next value.

Parameters

?Societe	$objsoc	Object third party
?FactureFournisseur	$object	Object invoice
string	$mode	'next' for next value or 'last' for last value

Returns

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

Reimplemented from ModeleNumRefSuppliersInvoices.

Definition at line 183 of file mod_facture_fournisseur_cactus.php.

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

Referenced by getNumRef().

getNumRef()

mod_facture_fournisseur_cactus::getNumRef	(		$objsoc,
			$objforref,
			$mode = 'next' )

Return next free value.

Parameters

Societe	$objsoc	Object third party
FactureFournisseur	$objforref	Object for number to search
string	$mode	'next' for next value or 'last' for last value

Returns

string Next free value

Deprecated

see getNextValue

Definition at line 267 of file mod_facture_fournisseur_cactus.php.

References getNextValue().

info()

mod_facture_fournisseur_cactus::info

(

$langs

)

Return description of numbering model.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 74 of file mod_facture_fournisseur_cactus.php.

---

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

• dolibarr_dev/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php