Create numbering module - Revision history

Mc2programmer: Fix typing and grammar.

2023-05-16T22:03:19Z

Fix typing and grammar.

← Older revision		Revision as of 22:03, 16 May 2023
Line 22:		Line 22:
	2. Modify the code for the info() method to return a text description of your module.		2. Modify the code for the info() method to return a text description of your module.

	3.Change the method code of ~~getExemple~~() to return ~~the~~ an example of ~~value for ra eference~~ that might be returned by the module.		3.Change the method code of getExample() to return an example value of a reference that might be returned by the module.

	4.Change the method code of canBeActivated() to just do a "return true;"		4.Change the method code of canBeActivated() to just do a "return true;"

Udo.tamm: add category Development

2020-03-09T17:57:43Z

add category Development

← Older revision		Revision as of 17:57, 9 March 2020
Line 11:		Line 11:
	For each entity (invoice, proposal, order, etc.) created in the application, Dolibarr assigned a reference number (or text). To adapt the reference to any use, Dolibarr uses numbering modules to define the rule of generation of this reference. The supplied modules are a standard one and a generic on with a configurable mask (numbers on x character, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the standard module does not meet the need. In this case it is necessary to develop its own numbering module.		For each entity (invoice, proposal, order, etc.) created in the application, Dolibarr assigned a reference number (or text). To adapt the reference to any use, Dolibarr uses numbering modules to define the rule of generation of this reference. The supplied modules are a standard one and a generic on with a configurable mask (numbers on x character, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the standard module does not meet the need. In this case it is necessary to develop its own numbering module.

	= Create a new module numbering =		=Create a new module numbering=

	For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.		For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.

	* Copy and paste htdocs/core/modules/invoice/earth/terre.modules.php in htdocs/core/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.		*Copy and paste htdocs/core/modules/invoice/earth/terre.modules.php in htdocs/core/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.
	* edit the new file to make the following changes in the code:		*edit the new file to make the following changes in the code:

	1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).		1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).

Line 36:		Line 37:
	6. Save: the template 'terrebis' is available in the list of invoice templates into Dolibarr		6. Save: the template 'terrebis' is available in the list of invoice templates into Dolibarr

	= Test this module =		=Test this module=
	Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info(), getExample() and getNextValue()).		Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info(), getExample() and getNextValue()).
			[[Category:Development]]

PolyglotBot: Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.

2019-07-23T13:20:11Z

Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.

← Older revision		Revision as of 13:20, 23 July 2019
Line 1:		Line 1:
			<!-- BEGIN origin interlang links -->
			<!-- You can edit this section but do NOT remove these comments
			Links below will be automatically replicated on translated pages by PolyglotBot -->
			[[fr:Créer_un_module_de_numérotation]]
			[[es:Crear_un_módulo_de_numeración]]
			[[zh:自动编号模块]]
			<!-- END interlang links -->

	{{TemplateDocDevEn}}		{{TemplateDocDevEn}}

R.ivnun: Undo revision 40300 by R.ivnun (talk)

2018-11-13T08:18:09Z

Undo revision 40300 by R.ivnun (talk)

← Older revision		Revision as of 08:18, 13 November 2018
Line 1:		Line 1:
	{{~~Template开发文档}}~~		{{TemplateDocDevEn}}
	~~{{Template用户手册}}~~
	~~{{TemplateMainPageZh~~}}

	对于在应用程序中创建的每个实体（发票、提案、订单等），Dolibarr分配了一个参考号（或文本）。为了适应任何使用的参考，DoiBar使用编号模块来定义这个引用的生成规则。提供的模块是标准模块和带有可配置掩码（x字符上的数字，带有或不带有前缀，包括日期或不带日期等）的通用模块，可以满足大多数需求。然而，仍然存在标准模块不满足需要的情况。在这种情况下，有必要开发自己的编号模块。		For each entity (invoice, proposal, order, etc.) created in the application, Dolibarr assigned a reference number (or text). To adapt the reference to any use, Dolibarr uses numbering modules to define the rule of generation of this reference. The supplied modules are a standard one and a generic on with a configurable mask (numbers on x character, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the standard module does not meet the need. In this case it is necessary to develop its own numbering module.

	= ~~创建新的自动编号模块~~ =		= Create a new module numbering =

	~~例如，我们假设我们将创建一个新的发票编号模块，我们将其称为“terrebis”，并且将是标准供应商模块“terre”的变体。~~		For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.

	*~~复制和粘贴htdocs~~/core/modules/invoice/earth/terre.modules.~~php于htdocs~~/core/modules/invoice/terrebis/terrebis.modules.~~php。你可以用你想要的名字代替terrebis，而他还不可使用，只包含字母字符。~~		* Copy and paste htdocs/core/modules/invoice/earth/terre.modules.php in htdocs/core/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.
	*~~编辑新文件以在代码中进行以下更改：~~		* edit the new file to make the following changes in the code:
	1. ~~重命名类名，用选定的名称替换旧类名（保持相同的命名约定）。~~		1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).

	2. ~~修改info~~()~~方法的代码，返回模块的文本说明。~~		2. Modify the code for the info() method to return a text description of your module.

	3.~~更改getExemple~~()~~的方法代码，返回模块可能返回的引用值示例。~~		3.Change the method code of getExemple() to return the an example of value for ra eference that might be returned by the module.

	4.~~将canBeActivated~~()~~的方法代码更改为只执行~~ "return true;"；		4.Change the method code of canBeActivated() to just do a "return true;"

	5.修改方法getNextValue()的代码，以返回下一个可用的引用编号。在这个函数的代码中，可以使用参数 $objsoc或$facture，其中包含参与生成的第三方的信息以及参与生成的对象发票（这些变量的名称可能根据被管理实体模块的性质而不同）。也可以使用对象$langs, $conf和$db，如果您在函数中首先声明它们

			5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne
	<source lang="php">		<source lang="php">
	global $langs, $db, $conf		global $langs, $db, $conf
	</source>		</source>
			where
			$conf contains all configuration of Dolibarr,
			$langs is an object for translation into user language,
			$db is a db connection object that allows SQL querying to database).

	此处		6. Save: the template 'terrebis' is available in the list of invoice templates into Dolibarr

	~~$conf 包含Dolibarr的所有配置，~~

	~~$langs 是翻译成用户语言的对象，~~
	~~$db 是允许SQL查询到数据库的DB连接对象。~~

	6. ~~保存：模板~~'terrebis'~~可在Dolibarr的发票模板列表中获得。~~

	= ~~测试模块~~ =		= Test this module =
	~~通过从配置页激活模块来测试此模块。验证列描述，例如，下个值，你得到你应该得到的反映（分别称info~~()~~，getExample~~()~~和getNextValue~~()~~的功能）。~~		Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info(), getExample() and getNextValue()).

R.ivnun at 08:17, 13 November 2018

2018-11-13T08:17:48Z

← Older revision		Revision as of 08:17, 13 November 2018
Line 1:		Line 1:
	{{~~TemplateDocDevEn~~}}		{{Template开发文档}}
			{{Template用户手册}}
			{{TemplateMainPageZh}}

	For each entity (invoice, proposal, order, etc.) created in the application, Dolibarr assigned a reference number (or text). To adapt the reference to any use, Dolibarr uses numbering modules to define the rule of generation of this reference. The supplied modules are a standard one and a generic on with a configurable mask (numbers on x character, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the standard module does not meet the need. In this case it is necessary to develop its own numbering module.		对于在应用程序中创建的每个实体（发票、提案、订单等），Dolibarr分配了一个参考号（或文本）。为了适应任何使用的参考，DoiBar使用编号模块来定义这个引用的生成规则。提供的模块是标准模块和带有可配置掩码（x字符上的数字，带有或不带有前缀，包括日期或不带日期等）的通用模块，可以满足大多数需求。然而，仍然存在标准模块不满足需要的情况。在这种情况下，有必要开发自己的编号模块。

	= ~~Create a new module numbering~~ =		= 创建新的自动编号模块 =

	~~For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.~~		例如，我们假设我们将创建一个新的发票编号模块，我们将其称为“terrebis”，并且将是标准供应商模块“terre”的变体。

	* ~~Copy and paste htdocs~~/core/modules/invoice/earth/terre.modules.~~php in htdocs~~/core/modules/invoice/terrebis/terrebis.modules.~~php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.~~		*复制和粘贴htdocs/core/modules/invoice/earth/terre.modules.php于htdocs/core/modules/invoice/terrebis/terrebis.modules.php。你可以用你想要的名字代替terrebis，而他还不可使用，只包含字母字符。
	* ~~edit the new file to make the following changes in the code:~~		*编辑新文件以在代码中进行以下更改：
	1. ~~Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).~~		1. 重命名类名，用选定的名称替换旧类名（保持相同的命名约定）。

	2. ~~Modify the code for the info~~() ~~method to return a text description of your module.~~		2. 修改info()方法的代码，返回模块的文本说明。

	3.~~Change the method code of getExemple~~() ~~to return the an example of value for ra eference that might be returned by the module.~~		3.更改getExemple()的方法代码，返回模块可能返回的引用值示例。

	4.~~Change the method code of canBeActivated~~() ~~to just do a~~ "return true;"		4.将canBeActivated()的方法代码更改为只执行 "return true;"；

			5.修改方法getNextValue()的代码，以返回下一个可用的引用编号。在这个函数的代码中，可以使用参数 $objsoc或$facture，其中包含参与生成的第三方的信息以及参与生成的对象发票（这些变量的名称可能根据被管理实体模块的性质而不同）。也可以使用对象$langs, $conf和$db，如果您在函数中首先声明它们

	5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne
	<source lang="php">		<source lang="php">
	global $langs, $db, $conf		global $langs, $db, $conf
	</source>		</source>
	~~where~~
	~~$conf contains all configuration of Dolibarr,~~
	~~$langs is an object for translation into user language,~~
	~~$db is a db connection object that allows SQL querying to database).~~

	6. ~~Save: the template~~ 'terrebis' ~~is available in the list of invoice templates into Dolibarr~~		此处

			$conf 包含Dolibarr的所有配置，

			$langs 是翻译成用户语言的对象，
			$db 是允许SQL查询到数据库的DB连接对象。

			6. 保存：模板'terrebis'可在Dolibarr的发票模板列表中获得。

	= ~~Test this module~~ =		= 测试模块 =
	Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info()~~, getExample~~() ~~and getNextValue~~()).		通过从配置页激活模块来测试此模块。验证列描述，例如，下个值，你得到你应该得到的反映（分别称info()，getExample()和getNextValue()的功能）。

Eldy at 22:57, 7 January 2013

2013-01-07T22:57:51Z

← Older revision		Revision as of 22:57, 7 January 2013
Line 7:		Line 7:
	For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.		For the example, we assume we will create a new numbering module of invoices, we will call it the 'terrebis' and will be a variant of the standard supplier module 'terre'.

	* Copy and paste htdocs/~~includes~~/modules/invoice/earth/terre.modules.php in htdocs/~~includes~~/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.		* Copy and paste htdocs/core/modules/invoice/earth/terre.modules.php in htdocs/core/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.
	* edit the new file to make the following changes in the code:		* edit the new file to make the following changes in the code:
	1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).		1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).

Eldy: /* Create a new module numbering */

2010-07-23T16:30:16Z

Create a new module numbering

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

	5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne		5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne
	global $langs, $db, $conf		<source lang="php">
			global $langs, $db, $conf
			</source>
	where		where
	$conf contains all configuration of Dolibarr,		$conf contains all configuration of Dolibarr,

Eldy: /* Create a new module numbering */

2010-07-23T16:26:51Z

Create a new module numbering

← Older revision		Revision as of 16:26, 23 July 2010
Line 20:		Line 20:
	global $langs, $db, $conf		global $langs, $db, $conf
	where		where
	$conf contains all configuration of Dolibarr.		$conf contains all configuration of Dolibarr,
	$langs is an object for translation into user language.		$langs is an object for translation into user language,
	$db is a db connection object that allows SQL querying to database).		$db is a db connection object that allows SQL querying to database).

Eldy at 16:26, 23 July 2010

2010-07-23T16:26:00Z

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

	5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne		5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne
	global $langs, $db, $conf		global $langs, $db, $conf
	where		where
	$conf contains all configuration of Dolibarr.		$conf contains all configuration of Dolibarr.

Eldy: /* Create a new module numbering */

2010-07-23T16:25:41Z

Create a new module numbering

← Older revision		Revision as of 16:25, 23 July 2010
Line 9:		Line 9:
	* Copy and paste htdocs/includes/modules/invoice/earth/terre.modules.php in htdocs/includes/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.		* Copy and paste htdocs/includes/modules/invoice/earth/terre.modules.php in htdocs/includes/modules/invoice/terrebis/terrebis.modules.php. You can use the name you want in place of terrebis while he is not already in use and contains only alphabetic characters.
	* edit the new file to make the following changes in the code:		* edit the new file to make the following changes in the code:
	# Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).		1. Rename the class name to replace the old class name with the chosen name (keep the same naming conventions).
	# Modify the code for the info() method to return a text description of your module.
	# Change the method code of getExemple() to return the an example of value for ra eference that might be returned by the module.		2. Modify the code for the info() method to return a text description of your module.
	# Change the method code of canBeActivated() to just do a "return true;"
	# Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db (db connection object ~~in the database~~ that allows SQL querying to database).		3.Change the method code of getExemple() to return the an example of value for ra eference that might be returned by the module.
	# Save: the template 'terrebis' is available in the list of invoice templates into Dolibarr
			4.Change the method code of canBeActivated() to just do a "return true;"

			5.Modify the code of the method getNextValue() to return the next available reference numbering. Within the code for this function, you can use parameters $objsoc or $facture containing the information of third parties involved in the generation and the object invoice involved in the generation (The name of these variables may differ depending on the nature of the managed entity module). You can also use the objects $langs, $conf and $db if you declare them first in the function with ligne
			global $langs, $db, $conf
			where
			$conf contains all configuration of Dolibarr.
			$langs is an object for translation into user language.
			$db is a db connection object that allows SQL querying to database).

			6. Save: the template 'terrebis' is available in the list of invoice templates into Dolibarr

	= Test this module =		= Test this module =
	Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info(), getExample() and getNextValue()).		Test this module by activating the module from configuration page. Verify that the column description, example and next value you get reflect what you should get (referred respectively by function info(), getExample() and getNextValue()).