ModeleThirdPartyCode Class Reference

Parent class for third parties code generators. More...

Inheritance diagram for ModeleThirdPartyCode:

Public Member Functions
	info ($langs)
	Returns the default description of the numbering pattern. More...
	getNom ($langs)
	Return name of module. More...
	getExample ($langs)
	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, $type=-1)
	Return next value available. More...
	getVersion ()
	Return version of module. More...
	getToolTip ($langs, $soc, $type)
	Return description of module parameters. More...
	verif_prefixIsUsed ()
	Check if mask/numbering use prefix. More...

Static Public Member Functions
static	liste_modeles ($dbs, $maxfilenamelength=0)
	Renvoie la liste des modeles de numérotation. More...

Detailed Description

Parent class for third parties code generators.

Definition at line 64 of file modules_societe.class.php.

Member Function Documentation

canBeActivated()

ModeleThirdPartyCode::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

Definition at line 116 of file modules_societe.class.php.

getExample()

ModeleThirdPartyCode::getExample

(

$langs

)

Return an example of numbering.

Parameters

Translate

$langs

Object langs

Returns

string Example

Definition at line 104 of file modules_societe.class.php.

getNextValue()

ModeleThirdPartyCode::getNextValue	(		$objsoc = 0,
			$type = -1
	)

Return next value available.

Parameters

Societe	$objsoc	Object thirdparty
int	$type	Type

Returns

string Value

Reimplemented in mod_codeclient_monkey, mod_codeclient_leopard, and mod_codeclient_elephant.

Definition at line 128 of file modules_societe.class.php.

getNom()

ModeleThirdPartyCode::getNom

(

$langs

)

Return name of module.

Parameters

Translate

$langs

Object langs

Returns

string Nom du module

Definition at line 93 of file modules_societe.class.php.

getToolTip()

ModeleThirdPartyCode::getToolTip	(		$langs,
			$soc,
			$type
	)

Return description of module parameters.

Parameters

Translate	$langs	Output language
Societe	$soc	Third party object
int	$type	-1=Nothing, 0=Customer, 1=Supplier

Returns

string HTML translated description

Definition at line 195 of file modules_societe.class.php.

getVersion()

ModeleThirdPartyCode::getVersion

(

)

Return version of module.

Returns

string Version

Definition at line 140 of file modules_societe.class.php.

info()

ModeleThirdPartyCode::info

(

$langs

)

Returns the default description of the numbering pattern.

Parameters

Translate

$langs

Object langs

Returns

string Descriptive text

Reimplemented in mod_codeclient_monkey, mod_codeclient_leopard, and mod_codeclient_elephant.

Definition at line 82 of file modules_societe.class.php.

liste_modeles()

static ModeleThirdPartyCode::liste_modeles (   $dbs,   $maxfilenamelength = 0  )

static

Renvoie la liste des modeles de numérotation.

Parameters

DoliDB	$dbs	Database handler
integer	$maxfilenamelength	Max length of value to show

Returns

array|int List of numbers

Definition at line 166 of file modules_societe.class.php.

verif_prefixIsUsed()

ModeleThirdPartyCode::verif_prefixIsUsed

(

)

Check if mask/numbering use prefix.

Returns

int 0=no, 1=yes

Reimplemented in mod_codeclient_elephant.

Definition at line 265 of file modules_societe.class.php.

---

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

• dolibarr_dev/htdocs/core/modules/societe/modules_societe.class.php