dolibarr: mod_supplier_proposal_marbre Class Reference

dolibarr 19.0.3

Class to manage the Marbre numbering rule for Request for quotation. More...

Inheritance diagram for mod_supplier_proposal_marbre:

Inheritance graph

[legend]

Collaboration diagram for mod_supplier_proposal_marbre:

Collaboration graph

[legend]

Public Member Functions
	info ($langs)
	Return description of numbering module.

	getExample ()
	Return an example of numbering module values.

	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

	getNextValue ($objsoc, $supplier_proposal)
	Return next value.

	getNumRef ($objsoc, $objforref)
	Return next free value.

Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name TODO Replace with getName()

	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 the Marbre numbering rule for Request for quotation.

Definition at line 32 of file mod_supplier_proposal_marbre.php.

Member Function Documentation

◆ canBeActivated()

mod_supplier_proposal_marbre::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 KO (there is a conflict), true if OK

Reimplemented from CommonNumRefGenerator.

Definition at line 91 of file mod_supplier_proposal_marbre.php.

◆ getExample()

mod_supplier_proposal_marbre::getExample ( )

Return an example of numbering module values.

Returns: string Example

Definition at line 78 of file mod_supplier_proposal_marbre.php.

◆ getNextValue()

mod_supplier_proposal_marbre::getNextValue	(		$objsoc,
			$supplier_proposal )

Return next value.

Parameters

Societe	$objsoc	Object third party
SupplierProposal	$supplier_proposal	Object commercial proposal

Returns: string Next value

Definition at line 129 of file mod_supplier_proposal_marbre.php.

References dol_print_date(), and dol_syslog().

Referenced by getNumRef().

◆ getNumRef()

mod_supplier_proposal_marbre::getNumRef	(		$objsoc,
			$objforref )

Return next free value.

Parameters

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

Returns: string Next free value

Definition at line 173 of file mod_supplier_proposal_marbre.php.

References getNextValue().

◆ info()

mod_supplier_proposal_marbre::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 66 of file mod_supplier_proposal_marbre.php.

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

dolibarr_19.0/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_marbre.php