mod_pacific Class Reference

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

Inheritance diagram for mod_pacific:

Collaboration diagram for mod_pacific:

Public Member Functions
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	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.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Class to manage numbering of intervention cards with rule Pacific.

Definition at line 33 of file mod_pacific.php.

Member Function Documentation

canBeActivated()

mod_pacific::canBeActivated

(

$object

)

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

Parameters

CommonObject

$object

Object we need next value for

Returns

boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 90 of file mod_pacific.php.

getExample()

mod_pacific::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefFicheinter.

Definition at line 78 of file mod_pacific.php.

getNextValue()

mod_pacific::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 129 of file mod_pacific.php.

References $object, and dol_print_date().

Referenced by getNumRef().

getNumRef()

mod_pacific::getNumRef	(		$objsoc,
			$objforref )

Return next free value.

Parameters

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

Returns

string Next free value

Deprecated

see getNextValue

Definition at line 174 of file mod_pacific.php.

References getNextValue().

info()

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

---

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

• dolibarr_dev/htdocs/core/modules/fichinter/mod_pacific.php