dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | List of all members
ModeleThirdPartyCode Class Reference

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)
 Renvoi nom module. More...
 
 getExample ($langs)
 Renvoi un exemple de numerotation. More...
 
 canBeActivated ()
 Test si les numeros deja en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner. 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)
 Renvoi la liste des modeles de numéroation. More...
 

Detailed Description

Parent class for third parties code generators.

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

Member Function Documentation

ModeleThirdPartyCode::canBeActivated ( )

Test si les numeros deja en vigueur dans la base ne provoquent pas de de conflits qui empechera cette numerotation de fonctionner.

Returns
boolean false si conflit, true si ok

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

ModeleThirdPartyCode::getExample (   $langs)

Renvoi un exemple de numerotation.

Parameters
Translate$langsObject langs
Returns
string Example

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

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

Return next value available.

Parameters
Societe$objsocObject thirdparty
int$typeType
Returns
string Value

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

Referenced by getToolTip().

ModeleThirdPartyCode::getNom (   $langs)

Renvoi nom module.

Parameters
Translate$langsObject langs
Returns
string Nom du module

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

Referenced by getToolTip().

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

Return description of module parameters.

Parameters
Translate$langsOutput language
Societe$socThird party object
int$type-1=Nothing, 0=Customer, 1=Supplier
Returns
string HTML translated description

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

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

ModeleThirdPartyCode::getVersion ( )

Return version of module.

Returns
string Version

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

Referenced by getToolTip().

ModeleThirdPartyCode::info (   $langs)

Renvoi la description par defaut du modele de numerotation.

Parameters
Translate$langsObject langs
Returns
string Texte descripif

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

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

Renvoi la liste des modeles de numéroation.

Parameters
DoliDB$dbDatabase handler
integer$maxfilenamelengthMax length of value to show
Returns
array List of numbers

Definition at line 148 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 244 of file modules_societe.class.php.


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