ModeleThirdPartyCode Class Reference

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

Inheritance diagram for ModeleThirdPartyCode:

Collaboration diagram for ModeleThirdPartyCode:

Public Member Functions
	__construct ($db)
	Constructor.
	getNextValue ($objsoc='', $type=-1)
	Return next value available.
	getToolTip ($langs, $soc, $type)
	Return description of module parameters.
	verif_prefixIsUsed ()
	Check if mask/numbering use prefix.
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.
	info ($langs)
	Returns the default description of the numbering template.
	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.

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

Detailed Description

Parent class for third parties code generators.

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

Constructor & Destructor Documentation

__construct()

ModeleThirdPartyCode::__construct ( $db )

abstract

Constructor.

Parameters

DoliDB

$db

Database object

Reimplemented in mod_codeclient_elephant, mod_codeclient_leopard, and mod_codeclient_monkey.

Member Function Documentation

getNextValue()

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

Return next value available.

Parameters

Societe | string	$objsoc	Object thirdparty
int	$type	Type

Returns

string Value

Reimplemented in mod_codeclient_elephant, mod_codeclient_leopard, and mod_codeclient_monkey.

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

Referenced by getToolTip().

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 124 of file modules_societe.class.php.

References getDolGlobalString(), CommonNumRefGenerator\getName(), getNextValue(), and yn().

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 94 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 192 of file modules_societe.class.php.

---

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

• dolibarr_20.0/htdocs/core/modules/societe/modules_societe.class.php