Créer un module de numérotation - Revision history

Hystepik at 12:54, 15 March 2022

2022-03-15T12:54:48Z

← Older revision		Revision as of 12:54, 15 March 2022
Line 28:		Line 28:

	5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne		5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	<~~source~~ lang="php">		<syntaxHighlight lang="php">
	global $langs, $conf, $db;		global $langs, $conf, $db;
	</~~source~~>		</syntaxHighlight>
	Ces objets contiennent:		Ces objets contiennent:
	$langs: les infos de la langue utilisateur,		$langs: les infos de la langue utilisateur,

Arre: /* Créer un nouveau module de numérotation */

2022-01-20T11:43:26Z

Créer un nouveau module de numérotation

PolyglotBot: Import interlang links (links to translated versions of this page in other languages) from origin English page "Create_numbering_module".

2019-07-23T13:20:11Z

Import interlang links (links to translated versions of this page in other languages) from origin English page "Create_numbering_module".

← Older revision		Revision as of 13:20, 23 July 2019
Line 1:		Line 1:
			<!-- BEGIN interlang links -->
			<!-- Do NOT edit this section
			Links below are automatically managed by PolyglotBot
			You can edit links on the English source page : Create_numbering_module -->
			[[en:Create_numbering_module]]
			[[es:Crear_un_módulo_de_numeración]]
			[[zh:自动编号模块]]
			<!-- END interlang links -->

	{{TemplateDocDev}}		{{TemplateDocDev}}

Eldy at 22:57, 7 January 2013

2013-01-07T22:57:30Z

← Older revision		Revision as of 22:57, 7 January 2013
Line 7:		Line 7:
	Pour l'exemple, on part du principe qu'on crée un nouveau module de numérotation de factures qu'on nommera 'terrebis' et qui s'inspire du module 'terre' fourni en standard:		Pour l'exemple, on part du principe qu'on crée un nouveau module de numérotation de factures qu'on nommera 'terrebis' et qui s'inspire du module 'terre' fourni en standard:

	* copier-coller ''htdocs/~~includes~~/modules/facture/terre/terre.modules.php'' en ''htdocs/~~includes~~/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.		* copier-coller ''htdocs/core/modules/facture/terre/terre.modules.php'' en ''htdocs/core/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.
	* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :		* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :
	1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).		1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).

Eldy: /* Créer un nouveau module de numérotation */

2010-07-23T16:29:56Z

Créer un nouveau module de numérotation

← Older revision		Revision as of 16:29, 23 July 2010
Line 18:		Line 18:

	5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne		5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	global $langs, $conf, $db;		<source lang="php">
			global $langs, $conf, $db;
			</source>
	Ces objets contiennent:		Ces objets contiennent:
	$langs: les infos de la langue utilisateur,		$langs: les infos de la langue utilisateur,

Eldy at 16:26, 23 July 2010

2010-07-23T16:26:31Z

← Older revision		Revision as of 16:26, 23 July 2010
Line 20:		Line 20:
	global $langs, $conf, $db;		global $langs, $conf, $db;
	Ces objets contiennent:		Ces objets contiennent:
	$langs: les infos de la langue utilisateur		$langs: les infos de la langue utilisateur,
	$conf: la configuration Dolibarr		$conf: la configuration Dolibarr,
	$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.		$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.

Eldy at 16:23, 23 July 2010

2010-07-23T16:23:32Z

← Older revision		Revision as of 16:23, 23 July 2010
Line 10:		Line 10:
	* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :		* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :
	1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).		1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).

	2. Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.		2. Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.

	3. Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.		3. Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.

	4. Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"		4. Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"

	5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne		5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	global $langs, $conf, $db;		global $langs, $conf, $db;
Line 19:		Line 23:
	$conf: la configuration Dolibarr		$conf: la configuration Dolibarr
	$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.		$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.

	6. Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr		6. Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr

Eldy at 16:23, 23 July 2010

2010-07-23T16:23:18Z

Eldy: /* Créer un nouveau module de numérotation */

2010-07-23T16:21:10Z

Créer un nouveau module de numérotation

← Older revision		Revision as of 16:21, 23 July 2010
Line 13:		Line 13:
	# Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.		# Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.
	# Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"		# Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"
	# Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module).		# Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module). Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	global $langs, $conf, $db;		global $langs, $conf, $db;
	Ces objets contiennent:		Ces objets contiennent:

Eldy at 16:20, 23 July 2010

2010-07-23T16:20:56Z

← Older revision		Revision as of 16:20, 23 July 2010
Line 9:		Line 9:
	* copier-coller ''htdocs/includes/modules/facture/terre/terre.modules.php'' en ''htdocs/includes/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.		* copier-coller ''htdocs/includes/modules/facture/terre/terre.modules.php'' en ''htdocs/includes/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.
	* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :		* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :
	1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).		# Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).
			# Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.
	2. Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.		# Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.
			# Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"
	3. Modifier le code de la méthode getExemple() afin de renvoyer un example de référence qui sera renvoyé par le module.		# Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible. Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module).

	4. Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"

	5. Modifier le code de la méthode getNextValue() afin de renvoyer la prochaine référence de numérotation disponible.

	Au sein du code de cette fonction, vous pouvez utilisez les paramètres $objsoc ou $facture qui contiennent les informations du tiers concerné par la génération et l'object concerné par la génération (Le nom de ces variables peut différer selon la nature des l'entité gérée par le module).
	Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne		Vous pouvez de plus utiliser les objets $langs, $conf et $db, à condition de les déclarer par la ligne
	global $langs, $conf, $db;		global $langs, $conf, $db;
Line 26:		Line 20:
	$conf: la configuration Dolibarr		$conf: la configuration Dolibarr
	$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.		$db: l'objet de connexion à la base qui permet d'effectuer des requêtes SQL en base.
			# Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr
	6. Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr

	= Tester ce module =		= Tester ce module =

← Older revision		Revision as of 11:43, 20 January 2022
Line 12:		Line 12:
	Pour chaque entité (facture, proposition, commande, etc) créée dans l'application, Dolibarr attribue une référence (numéro ou texte). Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules de numérotation pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.		Pour chaque entité (facture, proposition, commande, etc) créée dans l'application, Dolibarr attribue une référence (numéro ou texte). Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules de numérotation pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation.

	= Créer un nouveau module de numérotation =		=Créer un nouveau module de numérotation=

	Pour l'exemple, on part du principe qu'on crée un nouveau module de numérotation de factures qu'on nommera 'terrebis' et qui s'inspire du module 'terre' fourni en standard:		Pour l'exemple, on part du principe qu'on crée un nouveau module de numérotation de factures qu'on nommera 'terrebis' et qui s'inspire du module 'terre' fourni en standard:

	* copier-coller ''htdocs/core/modules/facture/terre/terre.modules.php'' en ''htdocs/core/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.		*copier-coller ''htdocs/core/modules/facture/terre/terre.modules.php'' en ''htdocs/core/modules/facture/terrebis/terrebis.modules.php''. Vous pouvez utilisez le nom que vous désirez a la place de terrebis pour peu qu'il ne soit pas déjà utilisé et ne contienne que des caractères alphabétiques.
	* éditer le nouveau fichier afin de faire les modifications suivantes dans le code :		*éditer le nouveau fichier afin de faire les modifications suivantes dans le code :

	1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).		1. Renommer le nom de la classe pour remplacer l'ancien nom de classe par le nom choisi (conserver les même conventions de nommages).

	2. Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.		2. Modifier le code de la méthode info() afin de renvoyer un texte descriptif de votre module.

	3. Modifier le code de la méthode getExemple() afin de renvoyer un ~~example~~ de référence qui sera renvoyé par le module.		3. Modifier le code de la méthode getExemple() afin de renvoyer un exemple de référence qui sera renvoyé par le module.

	4. Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"		4. Modifier le code de la méthode canBeActivated() afin de faire juste un "return true;"
Line 37:		Line 38:
	6. Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr		6. Sauvegarder : le modèle 'terrebis' est disponible dans la liste des modèles de factures de Dolibarr

	= Tester ce module =		=Tester ce module=

	Tester ce module en l'activant depuis la page de configuration du module.		Tester ce module en l'activant depuis la page de configuration du module.
	Vérifiez que dans la colonne description, exemple et valeur suivante, vous obtenez des informations cohérentes (renvoyées respectivement par les fonctions info(), getExample() et getNextValue() ).		Vérifiez que dans la colonne description, exemple et valeur suivante, vous obtenez des informations cohérentes (renvoyées respectivement par les fonctions info(), getExample() et getNextValue() ).