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

Inheritance diagram for ModeleThirdPartyCode:

Public Member Functions
	info ($langs)
	Renvoi la description par defaut du modele de numerotation. 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 ($db, $maxfilenamelength=0)
	Renvoie la liste des modeles de numérotation. More...

Detailed Description

Parent class for third parties code generators.

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

Member Function Documentation

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

ModeleThirdPartyCode::getExample ( $langs )

Return an example of numbering.

Parameters

Translate $langs Object langs

Returns: string Example

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

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

Return next value available.

Parameters

Societe	$objsoc	Object thirdparty
int	$type	Type

Returns: string Value

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

Referenced by getToolTip().

ModeleThirdPartyCode::getNom ( $langs )

Return name of module.

Parameters

Translate $langs Object langs

Returns: string Nom du module

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

Referenced by 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 197 of file modules_societe.class.php.

References getNextValue(), getNom(), getVersion(), and yn().

ModeleThirdPartyCode::getVersion ( )

Return version of module.

Returns: string Version

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

Referenced by getToolTip().

ModeleThirdPartyCode::info ( $langs )

Renvoi la description par defaut du modele de numerotation.

Parameters

Translate $langs Object langs

Returns: string Texte descripif

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

static ModeleThirdPartyCode::liste_modeles	(	$db,
		$maxfilenamelength = `0`
	)

static

Renvoie la liste des modeles de numérotation.

Parameters

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

Returns: array|int List of numbers

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

References $resql.

ModeleThirdPartyCode::verif_prefixIsUsed ( )

Check if mask/numbering use prefix.

Returns: int 0=no, 1=yes

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

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation