mod_facture_terre Class Reference

Class of numbering module Terre for invoices. More...

Inheritance diagram for mod_facture_terre:

Collaboration diagram for mod_facture_terre:

Public Member Functions
	__construct ()
	Constructor.
	info ()
	Returns the description of the numbering model. More...
	getExample ()
	Return an example of numbering. More...
	canBeActivated ()
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
	getNextValue ($objsoc, $invoice, $mode='next')
	Return next value not used or last value used. More...
	getNumRef ($objsoc, $objforref, $mode='next')
	Return next free value. More...
Public Member Functions inherited from ModeleNumRefFactures
	isEnabled ()
	Return if a module can be used or not. More...
	getVersion ()
	Renvoi version du modele de numerotation. More...

Detailed Description

Class of numbering module Terre for invoices.

Definition at line 31 of file mod_facture_terre.php.

Member Function Documentation

canBeActivated()

mod_facture_terre::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 ModeleNumRefFactures.

Definition at line 116 of file mod_facture_terre.php.

getExample()

mod_facture_terre::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefFactures.

Definition at line 105 of file mod_facture_terre.php.

getNextValue()

mod_facture_terre::getNextValue	(		$objsoc,
			$invoice,
			$mode = 'next'
	)

Return next value not used or last value used.

Note to increase perf of this numbering engine, you can create a calculated column and modify request to use this field instead for select: ALTER TABLE llx_facture ADD COLUMN calculated_numrefonly INTEGER AS (CASE SUBSTRING(ref FROM 1 FOR 2) WHEN 'FA' THEN CAST(SUBSTRING(ref FROM 10) AS SIGNED) ELSE 0 END) PERSISTENT; ALTER TABLE llx_facture ADD INDEX calculated_numrefonly_idx (calculated_numrefonly);

Parameters

Societe	$objsoc	Object third party
Facture	$invoice	Object invoice
string	$mode	'next' for next value or 'last' for last value

Returns

string Next ref value or last ref if $mode is 'last', <= 0 if KO

Reimplemented from ModeleNumRefFactures.

Definition at line 204 of file mod_facture_terre.php.

getNumRef()

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

Return next free value.

Parameters

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

Returns

string Next free value

Definition at line 288 of file mod_facture_terre.php.

info()

mod_facture_terre::info

(

)

Returns the description of the numbering model.

Returns

string Descriptive text

Reimplemented from ModeleNumRefFactures.

Definition at line 93 of file mod_facture_terre.php.

---

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

• htdocs/core/modules/facture/mod_facture_terre.php