Dolibarr ERP CRM Wiki - User contributions [en]

Module Stocks En

2021-05-01T09:25:54Z

Thecyyoung: /* Removal strategy */

[[fr:Module_Stock]]
[[es:Módulo_Stocks]]
[[de:Modul_Bestände]]


[[Category:Stock]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Stock|
num=52|
devdoc=[[Module Stock (developer)]]|
userdoc=This page|}}

=Introduction=
The Stock management module can save status for stocks of products into warehouses and edit/correct quantities of products.

It provides also features like Replenishments and Inventories.

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

The setup page allows you to choose from four options, when the stock is automatically incremented or decreased (depending on events in the order or invoice business process).

=Definition=

*'''Physical stock''' is the quantity of products in the warehouses.
*'''Virtual stock''' is the physical stock we will have once all pending sale, purchase and manufacturing orders will be done (so current real stock MINUS the number of products ordered by customers (orders with status "validated") PLUS the quantity ordered from suppliers (orders with status "sent to the supplier") MINUS quantity of product to consume in Manufacturing Orders PLUS quantity of product to produce in Manufacturing Orders (if you use them).

=Create a warehouse=
The creation of a warehouse is the mandatory first step for stock management. You can create a warehouse on the ''Products/Services'' tab, clicking ''Stocks'' on the left menu and then ''New warehouse stock''. The only required information is a reference code and a warehouse name, the other fields are optional. You must then set whether the warehouse is active or not (opened / closed). A closed warehouse cannot be used by other Dolibarr functions. This is a good way to prepare a warehouse with stock before you activate it, or to temporarily block stock movements during an inventory.

=Allocate product stocks=

*This has to be done from the ''stock'' tab on the page of the product, which can be found on the ''products'' section of the left menu.
*You can also do this from the ''stock'' tab on the page of the warehouse.

For multiple updates of stock, the import process should be used.

=Automatic stock updates=

Depending on the module configuration, the stock is updated either at the time of an order, at the time of shipment, at the time of invoice, etc.. A movement of stock is then registered according to the chosen increase/decrease stock option.

=Manual stock updates=

If you wish to make adjustments to the existing stock amounts (because of internal production, theft, loss, aging, ...), you can do it directly via :

*the tab "Stock" of a product.
*the tab "Stock movement" of a warehouse.

Use the button "Correct Stock" or "Transfer Stock" if you want to manually move some products from one warehouse to another one. Enter a code and label for the moment (for example to set the reason for the change).

=Replenishment=

The replenishment is a feature to generate orders for suppliers so your stock will be restored to a desired value.

=Inventories=

From menu Stocks - Inventories, you will find features to make an inventory.
See page [[Inventories]] for documentation on how to make an inventory.

=Warehouse strategy and valuation=

It is possible to obtain a detailed list of products and movements in a specific warehouse by clicking on the name from the list of warehouses.

==Removal strategy==
When using stock decrease on shipments, a removal strategy is a removal rule to decide which lot/batch/serial, or from which warehouse you take a product when you are doing a shipment.

*FIFO: First in, first out
*LIFO: Last in, first out
*FEFO: First expiry, first out

Currently, Dolibarr does not suggest any product lot or warehouse by priority when you ship a product.
You choose from the interface which product/lot quantity, from which warehouse you use. So the removal strategy is a manual selection by the user. You can choose according to FIFO, LIFO, or FEFO, at each shipment.

In a future, a removal strategy may be implemented so the application will use a default choice to suggest the lot/serial/warehouse/qty to match a default removal strategy rule.

==Stock valuation==
With Dolibarr, you can get a valuation of stock in two ways:

*Standard valuation: Current price of product * qty in stock
*Average Weight Price (AWP): AWP of product * qty in stock

=Related videos=
<youtube width="200" height="120">a0melQ2WTrY</youtube>

用户权限

2020-06-17T15:35:51Z

Thecyyoung: 1. 修正 listGroupForUser() 要傳入的是 id 而非物件 2. $listofgroup可能是從[1]開始

[[en:Permissions_En]]
[[es:Permisos]]
[[fr:Permissions]]


[[Category:Core]]
{{Template开发文档}}
{{Template用户手册}}
{{TemplateMainPageZh}}

每个权限都有唯一的ID.

Dolibarr 所管理的所有权限都保存到[[Table llx_rights_def]]中，并有自己的ID。

id用于在用户与权限之间建立链接（链接被保存到[[Table llx_user_rights]]）或在组和权限之间建立链接（链接被保存到[[Table llx_usergroup_rights]]）。

= 获取用户的权限和组 =

在Dolibarr页面的源代码中，全局对象$user被自动定义。

它包含当前用户的所有信息。

它的权限可以通过测试来测试。

<source lang="php">
if ($user->rights->module->codestringlevel1->codestringlevel1)
</source>

要知道用户是哪个组的列表，可以使用下面的代码（Dolibarr 2.5或更高）：

<source lang="php">
$usergroup=new UserGroup($db);
$listofgroups=$usergroup->listGroupsForUser($fuser->id);
print $listofgroups[0]->nom; // $listofgroups[1]->nom;
</source>

$listofgroups是用户$fuser所属的所有对象用户组（组）的数组。

$fuser是加载代码的对象用户

<source lang="php">
$fuser=new User($db);
$fuser->fetch('login');
</source>

= 可用权限数组 =

每个模块都有它的代码字符串来使用$user->rights数组来获取用户的相关权限。用于读取权限的代码列表可用于模块开发人员文档。

单击[[:Category:List of Modules|here to get full list of modules]] （并选择模块文档的开发者版本以获得可能的权限列表）。

模块开发

2020-06-07T16:25:48Z

Thecyyoung: /* 创建模块类 */

[[en:Module_development]]
[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]


[[Category:Core]]
{{Template用户手册}}
{{Template开发文档}}
{{TemplateMainPageZh}}

为开发Dolibarr模块，有以下几个步骤，本向导逐步引导你开发模块，扩展Dolibarr功能。包括以下内容 :

*在数据库中增加新表
*增加菜单条目
*为新表增加新的屏显
*增删对象的选项卡 (发票、产品、订单、事件，...)
*为导出工具添加预定义导出
*在主页增加插件（信息框）
*添加新的替换变量
*定义新权限
*执行由特定Dolibarr动作自动触发的代码
*将代码插入Dolibarr钩子位置
*添加编号模块（为数据自动编码的模块）
*添加文件模板
*添加新主题

等等...

下面的章节介绍了如何以简单的方式手动完成所有这些操作。对于有经验的开发人员来说，使用MDA生成的方法也不错。见最后一章。

=模块实例=
这里可以找到一个启动外部模块开发的好模型：[https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template Github Dolibarr模块]

=创建模块=

==激活ModuleBuilder模块==

从Dolibarr 6.0.0 开始，可以使用ModuleBuilder创建模块，为激活ModuleBuilder，按以下步骤：

*设置参数 MAIN_FEATURES_LEVEL 的值为 2 ( 设置 / 其他 )（或者修改llx_const表中该项的记录的value值为2）

[[File:企业微信截图 20180725114721.png|800px]]

*在'''主页-设置-模块'''中激活 ModuleBuilder.

[[File:激活modulebuilder.png|800px]]

*点击右上角的'Bug'图标开始使用（或者在浏览器中输入'yourhost/modulebuilder'）

[[File:Buglogo.png]]

*运行的ModuleBuilder界面如下：

[[File:Modulebuilder.png|800px]]

==创建模块类 (必需)==
'''何时''': 任何模块（除了主题）开始开发之日起。

'''自Dolibarr 6.0起, 应使用ModuleBuilder创建模块类'''

===用ModuleBuilder创建模块类 (新，Dolibarr v6.0起)===
在下图'模块名'处填入模块名，然后点击右侧的'创建'按键，创建模块类。

*改变模块ID值： $this->numero = 100000（将此100000变更为你为模块设置的ID值）。为了避免与其他模块发生冲突，您可以查阅列出已保留ID号的页面： [[List of modules id|模块ID列表]].
*修改模块类的构造函数中的其他变量的值 (参考[[主模块代码框架|类文件代码]]中的注释内容).

您的模块类已准备就绪。请参见下一步[[测试模块]]激活它。

[[file:模块名.png|800px]]

===创建模块类 (舊)===

*创建目录 '''/htdocs/''mymodule''/core/modules'''. 从目录/modulebuilder/template/core/modules拷贝文件modMyModule.class.php到新建目录。

将 modMyModule.class.php 改名，名称对应于您的模块。名称以 'mod'开头，以.class.php结尾。 (例如：要创建模块 'NewName', 对应的模块名为'modNewName.class.php').
接下来修改此文件的内容如下：

*替换所有 "modMyModule"，对应于模块名称。此值须以'mod'开头且仅含字符（例如，模块为 'NewName', 替换所有 "modMyModule" 为 "modNewName"）。
*改变模块ID值： $this->numero = 100000（将此100000变更为你为模块设置的ID值）。为了避免与其他模块发生冲突，您可以查阅列出已保留ID号的页面： [[List of modules id|List of modules id]].
*修改模块类的构造函数中定义的其他变量的值 (参考[[主模块代码框架|类文件代码]]中注释的内容).

您的模块的文件描述符已准备就绪。请参见下一步[[测试模块]]激活它。

===测试模块===

找到 '''设置->模块'''。
如果正确的设置了版本，你会看到模块及模块的激活开关。如果版本设置为了"develop" 或 "experiental", 则必须到 '''设置->其他'''中设置MAIN_FEATURES_LEVEL 为 1 来查看 "experimental"版模块或 2 来查看 "development"版模块。

==模块类路径树（必需）==

模块组织文件的方法（zip文件须与此匹配）。

注：只有第二行是强制性的。

{{Template模块目录树}}

==创建数据表和表的PHP类文件 (可选)==
'''何时''': 模块有自己的数据

===创建.sql文件===
如果你的模块有自己的数据要管理，而Dolibarr的标准版中没有这些数据，就需要自定义数据库表来存储数据。

创建表和加载数据的脚本文件必须放在你的模块目录中创建子目录“sql”中(如htdocs/mymodule/sql)

检查模块主文件，"init"函数中是否包括行：

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

''规则:''

*新建表的命令在文件 '''llx_mytable.sql'''中, 或者还有 '''llx_mytable.key.sql''' (参见 '''install/mysql/tables''' 实例).
*管理数据：在目录 '''/mymodule/sql/'''中创建文件 '''data.sql''' 文件中包括增删模改数据的命令。
*不要使用双引号 (如使用 'chaine' 而不使用 "chaine") 因为双引号有特殊意义(PostGreSQL)。

data.sql实例
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

对于MySQL数据库，文件必须是可操作的。REM：其他数据库的文件不被维护。它们将由另一个数据库的驱动程序进行读取和转换。

===测试 .sql 文件===

一旦文件准备就绪，您可以返回Dolibarr以禁用该模块，在数据库中将模块使用的表删除，并重新激活模块。应该能通过激活模块来重新创建表。否则，请通过手动传递脚本，或者检查Dolibarr日志。

===生成 PHP DAO 类文件===
一旦将表创建到数据库中，就转到DEV/Skeleto目录
<source lang="bash">php build_class_from_table.php tablename modulename</source>
注意：如果命令不工作，尝试使用PHP-CLI PHP代替。
这将生成一个文件'''out.tablename.class.php'''，它包含管理表tablename的类。
在这个类中，您可以找到CRUD方法（Create / Read / Update / Delete），在其中进行插入、获取（选择）、更新、删除表中的行。
从文件名中删除“out”，并将文件放在“模块”的子目录中（例如，在htdocs/mymodule/class中）。

已经生成了一个文件'''out.tablename_script.php'''，并包含一个示例代码，使用了4个CRUD方法中的每一个。

''自从Dolibarr 6.0开，不再提供文件'''dev/skeletons/build_class_from_table.php'''。要从一个表生成一个类，您应该使用'''ModuleBuilder'''模块。''

===使用ModuleBuilder生成PHP DAO类文件===

*使用ModuleBuilder生成PHP DAO类文件，简单至在下图中选对'对象'选项卡，输入'对象名'，然后点击创建，即可生成相关一切文档。

[[File:新对象.png|800px]]

参见[[ModuleBuilder用户手册]]
==选项卡管理(可选)==

===增删对象的选项卡===
'''何时''': 增加对象选项卡 (对象是指‘发票’、‘订单’、‘提议’、‘会员’等等)

为此，进入先前创建的模块主文件，并编辑$this->tabs数组：

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

该数据包含一个字符串列表，每个字符串表示一个新选项卡。
字符串由":"分隔的6个部分组成。

*Part 1: 选项卡出现在的对象类型（objecttype），只能是以下值：
{{TemplateModuleTabs}}

*Part 2: 标识选项卡是添加（以+开始）或移除（以-start）的代码
*Part 3: 选项卡的标题。这可以是lang文件中的译文代码或者是一个直接的字符串。
*Part 4: 文件“*.lang”的名称，包含译文代码和要显示的语言之间的对应关系。如果这个名字跟随 @mymodule，Dolibarr将搜索模块内的翻译文件“*.lang”，即"htdocs/mymodule/langs/code_CODE/mylangfile.lang"。否则Dolibarr将查找文件"htdocs/langs/code_CODE/mylangfile.lang"
*Part 5: 测试选项卡是否必须可见的条件。为1则一直可见。
*Part 6: 单击选项卡时要显示的页面的URL。字符串__ID__将由相关元素的ID自动替换。

要用数据库中的数据来填充选项卡的内容，请参阅下一章。

===在你的页上显示选项卡导航===
'''何时''': 在页面上显示对象的所有标准选项卡（产品、第三方等）。

你必须遵循这些步骤：

'''1. 包含文件中需要的文件'''

对于每个对象类型，有两个文件要包含。
<source lang="php">require_once($url_fichier) ;</source>

包含示例 (DOL_DOCUMENT_ROOT 代表 dolibarr/htdocs/) :

*对象第三方(thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*对象产品(product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*对象发票 (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. 创建并加载对象以显示在您的选项卡中'''

通过从url(ie : /mytab.php?id=1)获取的id值，使用对象的获取方法，从数据库中创建正确的类和加载对象的实例。

''例如：''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. 为你的对象类型获取所有可显示的选项卡列表'''

使用函数XXX_prepare_head($obj)，其中XXX是对象的名称。这将返回一个数组，包含所有选项卡条目的定义。要放入该方法的参数是要显示选项卡的对象实例。

返回的数组为：
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''例如 :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // 参数 $user 是要显示选项卡的对象，这就是"产品"对象为"user"对象准备的所有可用的选项卡的数组。
</source>

'''4. 在你的页面上显示选项卡'''

使用函数dol_fiche_head()显示由函数XX_prepare_head()返回的$head数组定义的定义的所有选项卡。

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

==创建或修改 PHP 屏显 (可选)==
'''何时''': 如果模块的目的是为了修改屏显。

===创建新 PHP 屏显===
然后，您必须创建PHP页面，使用目录'''modulebuilder/myobject_page.php'''中提供的框架模板来显示/编辑表中的数据。 (从命令行开发脚本，见 [[Script development]]).

要创建一个新的用户屏幕，创建一个模块名的子目录(若无) (例如 '''htdocs/mymodule''') 来存储创建的屏幕。

复制 '''myobject_page.php''' 做为屏幕页。

编辑该文件，以包括正确的 '''main.inc.php'''文件。
<source lang="php">
// Load Dolibarr environment
$res=0;
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");
// Try main.inc.php into web root detected using web root caluclated from SCRIPT_FILENAME
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");
// Try main.inc.php using relative path
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");
if (! $res) die("Include of main fails");
</source>
注：你可能增加更多的 "../" 根据你的模块目录的深度。
在3.2之后，为所有版本的Dolibarr开发的模块应该能够在不同的文件夹中移动，而不是“htdocs”，比如“htdocs/custom”，而不必修改模块的源代码，这就是为什么我们要做几个包含，所以这个规则必须被所有模块应用。

在main.inc.php文件中，加载了技术环境变量和权限。以下变量是位于该文件中的对象：

*$user 包含用户+ 权限。
*$conf 包含 Dolibarr 设置
*$db 它包含一个打开的数据库连接处理程序。
*$langs 包含用户语言

然后输入代码显示页面。

*包含模块专属的类或库，使用Dolibarr函数dol_include_once()（而不是直接使用 include_once）：

''例如 :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

*若要包含Dolibarr提供的类，请使用以下语法：

''例如 :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

===为现存表单增加新字段===
您可能需要提供一个模块，该模块将更多字段添加到一些元素的表单（输入和查看）中。

一个较累的解决方案（但不是很糟糕）是替换所有用于创建元素的页面（这意味着禁用“新元素”菜单条目并添加您的，禁用“显示”元素，用一个选项卡替换该元素，该选项卡是您自己的完整页面（从原始复制/粘贴），以完成与原始页面相同的操作，修改以添加字段并将添加的数据存储到自己的表中）。

转到菜单 [[#Define your entries in menu (optional)]]和[[#The tab management (optional)]]，如果这个解决方案适合你（这个解决方案是更强大的，因为你可以改变你想要的一切进入页面）。

我们将在这里描述另一种解决方案，它只在现有字段结束时“添加字段”，使用元素“category”作为示例，但您可以将此教程转换为发票、提案…

*首先，添加一个由您的模块所拥有的表，以存储新字段的值。此表有一个名为“rowid”的列（将包含与元素表的字段rowid相同的值+每一个要添加的新字段的列。然后为这个新表创建一个CRUD（创建/读取/更新/删除）方法类。对于这两个任务，请回到前一章[[#创建数据表和表的PHP类文件 (可选)]]。
*下一步是在模块中添加一个钩子，以将新字段添加到窗体中。有关使用钩子的通用文档，请参见[[Hooks_system#Implement_the_Hook]]章节。

如果您遵循本教程，以便能够将字段添加到类别窗体中，您必须这样做：
{{ToComplete}}

===替换模板的部分内容 (version 3.3+)===
Dolibarr屏幕的一些部分被隔离到本地PHP模板文件中。
您可以开发一个模块来覆盖这样的模板。
{{ToComplete}}

===增/换部分字段（需钩子支持）===
要知道如何使用Dolibarr现有的钩子来添加/替换Dolibarr 钩子代码，参考 [[钩子系统#实现钩子]] 。

===数据通道===
如果需要在自己的表中编辑数据库中的一些数据，请使用的PHP类。

如果您要访问没有专用PHP类的表（例如，如果您想获得具有特定连接或筛选器的记录列表）。在这种情况下，这是要遵循的代码示例：

进行插入、更新或删除：

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

读:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

===页面风格===
为了让你自己的页面看起来与Dolibarr主题相匹配，必须使用Dolibarr CSS样式。

例如，您可以使用：

*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
*class="'''flat'''" on all input fields (''input, select, textarea''...).
*class="'''button'''" on HTML fields with type ''input type="submit"''.

===使用Dolibarr日期选择器===
如果您的页面使用Dolibarr日期选择器（日历弹出），请使用以下行：
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
字符串mykey将标识表单中的日期选择器。如果在同一页中使用多个日期选择器，则必须使用不同的值。

字符串myform是包含选择器的表单的名称（在HTML页面中的form name="myform"）中找到的值。

这意味着日期选择器必须包含在HTML表单中。

要获得表单POST的值，命令是：
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

==新增设置页 (可选)==
'''何时''': 如果模块需要用户提供的参数，以正确设置模块。

===创建页面以编辑参数===
如果模块需要设置几个参数，则必须创建一个页面来编辑选项。 (这些制作存储于 [[Table llx_const|表 '''llx_const''']]).

新建 '''mymodule_setuppage.php''' 这显示了可能的选项的表单，将它们更新到上面提到的表中。

有必要从目录''/admin ''的页面中获取一个示例，它将向您展示读取/保存参数的方法。

把这个PHP页面放到你的模块的''/admin ''（例如mymodule/admin/mymodule_setuppage.php）的目录中。

===修改模块主文件===
然后，在模块主文件中，将变量“config_page_url”修改为PHP页面的设置名称。

如果页面位于目录'''admin/'''中，则不需要路径，例如：
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

如果页面在目录 '''mymodule/admin/'''中，则像这样：
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

===测试页面===
进入'''首页->安装>模块'''，您应该在您的模块行的末尾看到一个图片，以转到您的设置页面。点击它，你就可以从页面中查看/编辑参数。

==增加菜单条目 (可选)==
'''何时''': 如果您创建了PHP页面，则必须从Dolibarr菜单中的菜单条目中访问这些页面。

===增加菜单条目===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

===测试菜单===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==新增权限 (可选)==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

==信息窗 (可选)==
'''When''': If your module need to provide one or several new boxes to show on home page.

===信息窗===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

===Test if your box is detected by Dolibarr===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

==Define your own export (optional)==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

===导出===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

===Test your export===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

==Define your CSS styles (optional)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

===Create and declare your style sheet===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

===Test your style sheet===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

==增加JS函数功能 (可选)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

==执行Dolibarr事件代码 (可选)==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

==钩子代码 (可选)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

==添加编码规则==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

==创建文档模板 (optional)==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

==创建主题 (optional)==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

==修改开发模块作者名==

在myModule.class.php中查找editor_name

修改以下变量的值以修改作者名称
<source lang="php">
$this->editor_name = 'Roger@QQ:12464313';
$this->editor_url = 'https://www.ivnun.cn';
</source>

=一些编码规则和预定义函数=
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=创建一个安装包来分发和安装您的模块=
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

*Run the script via Perl (need the Perl version 5.0 or later):

<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:

<source lang="bash">
tar -xvf mymodule.zip
</source>

*If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
**If your module was build correctly, file will be validated later.
**If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

=Delistor上的外部模块的启用/激活条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

翻译文档

2020-05-05T14:03:45Z

Thecyyoung: /* 手动翻译（不推荐） */

[[en:Translator_documentation]]
[[fr:Documentation_traducteur]]
[[es:Documentación_traductores]]
[[de:Dokumentation_Uebersetzung]]


<seo metak="translation, documentation, translator, localize, localization, i18n, internationalization, language" />
{{Template用户手册}}
{{TemplateMainPageZh}}

= [[File:Language.png]] 翻译 Dolibarr =

Dolibarr语言文件已经用几种语言翻译了。
英语是默认的语言会首先完成翻译。其他语言依赖于自愿者的贡献。本教程帮助您完成一个未译的或错译的语言。
Dolibarr可以用三种不同的方式翻译：

# 手动使用Transifex （官方和推荐的方法）
# 手动编辑语言文件
# 全自动：自动翻译机

== 使用Transifex在线服务进行手动翻译（推荐）==

Transifex 是一个为翻译项目提供在线平台的Web应用程序。它包括团队和讨论工具、翻译记忆、词汇表、校对和许多其他特征。
它非常容易使用，所有翻译都可以通过Web界面上传或下载，或者使用来自终端的TX客户端。
Transifex 是一个开源项目，“社区版”可以免费下载和安装，但我们将使用在线托管服务。

===使用Web界面（译者）===
如果你想用自己的语言帮助翻译Dolibarr，请检查项目的页面。 https://www.transifex.com/dolibarr-association/dolibarr/

然后，您可以注册一个帐户，并请求加入项目团队，以您的语言为目标。管理员会接受你的要求，所以请耐心等待。

一旦被接受，你就可以马上开始翻译了。

欲了解更多信息，请检查Transifex“入门”介绍规范 http://docs.transifex.com/introduction/translators/ 和网络编辑器向导于 http://docs.transifex.com/tutorials/txeditor/

===='''备注关于 en_US'''====
Web界面不能用来翻译源代码的en_US语言。

任何更改都必须在Dolibarr源代码中完成，并在GitHub存储库上使用Pull请求提交。

=== 使用TX 命令行客户端 (for Dolibarr [[:Category:Yoda]] team) ===
这描述了如何从命令行中使用Transifex。然而，这是保留给Dolibarr管理员用户，以同步Transifex与Dolibarr主源码。

[http://docs.transifex.com/developer/client/ 官方文档]

====TX 客户端设置====
安装 TX 客户端
使用 Debian/Ubuntu/Mint:
<source lang="bash">
apt-get install python-pip
pip install transifex-client
</source>
然后你必须初始化你的TX环境。这是通过进入Dolibarr项目根目录运行'tx init ''来完成的。
<source lang="bash">
cd git/dolibarr
tx init
</source>
接受改写配置文件。保持Transifex实例的默认值，然后输入您的Transifex登录和密码。

在此之后，一个.transifexrc已经创建到您的主页目录，并且一个通用配置文件被创建于项目根目录中的'''.tx/config'''。
所以目录的内容会是这样的：
所以目录的内容会是这样的：
<code><pre>
.
|-- build
|-- build.xml
|-- ChangeLog
|-- COPYING
|-- COPYRIGHT
|-- dev
|-- doc
|-- .gitignore
|-- htdocs
|-- INSTALL
|-- pom.xml
|-- quickbuild.xml
|-- README
|-- README-FR
|-- README.md
|-- robots.txt
|-- scripts
|-- test
`-- .tx
</pre></code>

当前配置文件可以从 https://github.com/Dolibarr/dolibarr/tree/develop/.tx 下载，放入.tx目录，重写由'tx init ''创建的目录。

此项目配置文件用于将项目的详细信息和文件存储到资源映射。

这是配置文件包含内容的示例：

<source lang="ini">
[main]
host = https://www.transifex.com
lang_map = uz: uz_UZ

[dolibarr.admin]
file_filter = htdocs/langs/<lang>/admin.lang
source_file = htdocs/langs/en_US/admin.lang
source_lang = en_US
type = MOZILLAPROPERTIES
</source>

下面是配置文件中使用的部件和选项的说明：

<nowiki>[main] section</nowiki>

在本节中，我们有项目范围的选项，例如：所有项目的默认transifex主机。如果需要的话，这些资源可以被每个资源重写。

<nowiki>[dolibarr.resource]</nowiki>

source_lang: this is the source language of the resource.<br/>
source_file: this points to the source file directly.<br/>
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory''<br/>
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory''<br/>
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory''<br/>

====TX 客户端使用====
'''tx''' 命令有用的信息。

'''tx status'''

显示翻译状态

'''tx push'''

用于推送更改，从你的计算机到Transifex服务器

TX推送命令的其他选项是：

<code><pre>
-h - 显示命令行帮助
-l <lang> - 指定要推送哪些翻译（默认为所有）
-r <resource> - 指定要向其推送翻译的资源（默认为所有）
-f - 在不修改修改时间的情况下推送源文件
--skip - 错误时不要停止。当同时推多个文件时很有用。
-s - 将源文件推送到服务器
-t - 将翻译文件推送到服务器
--no-interactive - 强制推送时不需要用户输入。</pre></code>

'''tx pull'''

用于从Transifex服务器将更改拉到您的计算机上<br/>
TX拉动命令的其他选项是：
<code><pre>
-h - Shows the help screen for the command
-l <lang> - Specify which translations you want to pull (defaults to all)
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
-a - Fetch all translation files from server (even new ones)
-s - Force the fetching of the source file (default: False)
-f - Force download of translations files
--skip - Don't stop on errors. Useful when pushing many files concurrently.
--disable-overwrite - By default Transifex will fetch new translations files and replace existing ones. Use this flag if you want to disable this feature.
--minimum_perc=VALUE - Specify the minimum acceptable percentage of a translation in order to download it.</pre></code>

'''例'''

要取得翻译文档,使用:

<source lang="bash">
tx -d pull -l it_IT # Get italian language only
tx -d pull -a # Get all languages
</source>

要上传源文件,键入:

<source lang="bash">
tx -d push -t -l it_IT [-r dolibarr.file] # To push only a specific translation file
tx -d push -s # To push source file
</source>

=== transifex流程的其他问题 ===
这是一个简短的Q&A，你也可以问一下transifex翻译过程：

1) 是在一个固定的时间间隔上的同步?

不，它是在有足够的翻译提交的地方完成的。在创建最终发布包之前，它也在beta分支上完成。

2) 是否所有的翻译同步到Git，或者仅仅是经过审查的翻译。在同步完成之前我需要复习吗？ ?

当同步完成时，transifex文件将文件覆盖到Git中，但前提是至少为文件修改了记录。
在同步完成之前，您不必进行复查。最重要的是，要知道哪些线是手工评审的，哪些是最初用机器人翻译的。

3) Dolibarr发布的版本将有翻译吗？transifex 翻译也与维护版本同步?

同步总是在开发和/或beta上完成。
因此，transifex更改出现在所有版本中，其分支是在transifex更改之后创建的（在创建新分支之前总是进行同步）。

一旦创建了一个分支，那么新的过渡到transifex将只适用于下一个分支。这是因为transifex无法管理分支/版本（还没有）。

== 手动翻译（不推荐） ==

要将Dolibarr翻译成另一种语言，请转到Langs目录，并创建一个用代码语言命名的文件夹/目录来翻译（遵循现有格式，例如en_US, en_GB, es_ES, de_DE, 等）。然后将文件从现有的语言目录（例如en_US/main.lang, en_GB/bills.lang）复制到刚刚创建的新语言目录中。

这些文件在每行中具有键/值对的格式，如下所示：

<source lang="ini">
Code1 = translate phrase 1
Code2 = translate phrase 2
...
Coden = translate phrase n
</source>

将短语（键值对的值部分）翻译你的语言，“=”的左边的代码（键部分）应该保持不变。

可以逐个翻译这些文件，而不必一次就把它们全部翻译出来。

如果文件没有被翻译成新的语言，Dolibarr将使用英语。

要在PHP代码中有一个本地化的（翻译的）字符串，你所要做的就是加载语言文件并使用该方法得到翻译值，如下所示：

<source lang="php">

$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX

print $langs->trans("CodeX")
</source>

条目类型;

<source lang="ini">
CodeX = phrase X
</source>

必须存在或添加到myfile.lang文件。

== 使用autotranslator.php工具自动翻译 ==

* Translator OS: All
* Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.
This method is recommended when starting translation for a language not already initialized. If there is already a translation available but you need to add missing key or correct errors, try to use method using Transifex (see later).

To make or update all files of a language code, just run the script:
<source lang="bash">
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
</source>
For example :
<source lang="bash">
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
</source>
to translate into Portuguese (pt_PT) using English (en_US) files.

All non existing files will be created, all existing files will be updated.
The tool use [http://translate.google.com Google translation] service to find the translation value of a string, so a working Internet connection is required from station running the script. Also a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).
Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.

= [[File:Language.png]] 将你的翻译分发到核心资源中 =

Once you start translating, it's a smart decision to share it, so it can be included into the official code of Dolibarr.
If you keep it for you, others will not be able to improve it when new terms are added or previous terms are modified, and you will still have to manage the translation on your own.

If you translated through the Transifex system, there's nothing to be done. Your translation will be included in the next version of Dolibarr. No additional work! In technical terms, the translation will be exported from Transifex and imported into Dolibarr by our developers, at least once every month.

If, however, you translated directly in Dolibarr files, then you will first have to transfer those translations to Transifex before they can be included. So, really, you should start translating into Transifex.
If you send us your translation through a Pull Request on Github, sadly, it will be overwritten by the next import from Transifex, so it would be very short-lived.

Note:

The reference language is en_US and is always complete. You can find it in the htdocs/langs/en_US/ folder. All other language files are likely to be slightly or highly incomplete, depending on the language.

If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.

= [[File:Language.png]] 翻译Wiki文档 =
维基是用3种语言写成的：英语、法语和西班牙语。

如果你想增强这些语言中的一种语言，你所要做的就是在Wiki上创建一个帐户。

然后，您可以编辑现有的页面来纠正错误的翻译或翻译等待翻译的页面。 [[:Category:Page_waiting_for_translation]].

User talk:Thecyyoung

2020-05-03T12:11:32Z

Thecyyoung: A confusing issue of accounts.

The account of Dolibarr Form doesn't connect to the account of Dolibarr Wiki.

User:Thecyyoung

2020-05-03T12:08:27Z

Thecyyoung: Describe myself.

I am The Cy Young from Taiwan.