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 ()
	Return description of numbering module. 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=0, $object='')
	Return next free value. More...
	getNumRef ($objsoc, $objforref)
	Return next free value. More...
Public Member Functions inherited from ModeleNumRefFicheinter
	isEnabled ()
	Return if a module can be used or not. More...
	getVersion ()
	Return the version of the numbering module. More...

Detailed Description

Class to manage numbering of intervention cards with rule Pacific.

Definition at line 31 of file mod_pacific.php.

Member Function Documentation

canBeActivated()

mod_pacific::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 ModeleNumRefFicheinter.

Definition at line 86 of file mod_pacific.php.

getExample()

mod_pacific::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefFicheinter.

Definition at line 75 of file mod_pacific.php.

getNextValue()

mod_pacific::getNextValue	(		$objsoc = 0,
			$object = ''
	)

Return next free value.

Parameters

Societe	$objsoc	Object thirdparty
Object	$object	Object we need next value for

Returns

string Value if KO, <0 if KO

Reimplemented from ModeleNumRefFicheinter.

Definition at line 125 of file mod_pacific.php.

getNumRef()

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

info()

mod_pacific::info

(

)

Return description of numbering module.

Returns

string Text with description

Reimplemented from ModeleNumRefFicheinter.

Definition at line 64 of file mod_pacific.php.

---

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

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