mod_arctic Class Reference

Class to manage numbering of intervention cards with rule Arctic. More...

Inheritance diagram for mod_arctic:

Collaboration diagram for mod_arctic:

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.
	getNumRef ($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 numbering of intervention cards with rule Arctic.

Definition at line 35 of file mod_arctic.php.

Member Function Documentation

getExample()

mod_arctic::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefFicheinter.

Definition at line 108 of file mod_arctic.php.

References getNextValue().

getNextValue()

mod_arctic::getNextValue	(		$objsoc = '',
			$object = '' )

Return next free value.

Parameters

Societe | string	$objsoc	Object thirdparty
Fichinter | string	$object	Object we need next value for

Returns

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

Reimplemented from ModeleNumRefFicheinter.

Definition at line 130 of file mod_arctic.php.

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

Referenced by getExample(), and getNumRef().

getNumRef()

mod_arctic::getNumRef	(		$objsoc,
			$objforref )

Return next free value.

Parameters

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

Returns

string|int Next free value, 0 if KO

Deprecated

see getNextValue

Definition at line 161 of file mod_arctic.php.

References getNextValue().

info()

mod_arctic::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 67 of file mod_arctic.php.

References getDolGlobalString(), and name.

---

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

• dolibarr_21.0/htdocs/core/modules/fichinter/mod_arctic.php