Dolibarr ERP CRM Wiki - User contributions [en]

JA First setup

2023-11-21T07:01:32Z

Cin TAKE:

{{DISPLAYTITLE:初期設定}}

{{TemplateDocUserJa}}

初回インストール後、自分の要件に合わせて Dolibarr のパラメータ設定をすること.

=法人/組織=
最初必須ステップは自分の法人/組織情報を定義すること. このため、ホームページから、メニュー選択 "'''ホーム->設定->法人/組織'''" して自分の法人/組織の情報を追加する.

*'''名:''' 自分の法人/組織の名前
*[[File:Logo size.jpg|thumb]]'''ロゴ:''' Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
*'''ロゴ (正方形):''' Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
*'''会計年度:''' 自分の会計開始月を定義
*'''国:''' Define your country: other options depend on this selection.

*'''職業分類ID X:''' The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.

*'''消費税(VAT)管理:''' Define how you manage Sales Tax (or not).
*'''2種目の税金:''' Define if you would like to use second type of taxe (or not).
*'''3種目の税金:''' Define if you would like to use third type of taxe (or not).

=モジュールs=
[[File:List of modules en.png|alt=List of modules|thumb|List of modules]]
The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.

To activate a module, go to page "'''Home->Setup->Modules'''" and click the button 'on/off' in the "Status" column to enable it.

*The module is '''on''' if the 'on/off' button is like [[File:On off button on.png|alt='on/off' button in on position|'on/off' button in on position]]
*The module is '''off''' if the 'on/off' button is like [[File:On off button off.png|alt='on/off' button in off position|'on/off' button in off position]]

The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].

If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.

Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See [[:Category:List of Modules|documentation of module]] for more information.

Related videos:

Modules:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Module settings:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

=表示=
[[File:Display settings EN.png|alt=Display settings|thumb|Display settings]]
On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.

==言語==
In the language settings, you can set the Default Language. By default it is set to "Auto Detect".
''Note:'' Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.

==Default skin theme==
In Dolibarr you have two different skins :

*eldy [[File:Eldy Theme thumb.png]]
*md [[File:Md theme thumb.png]]

More skins can be downloaded on the dolistore [https://www.dolistore.com/4-skins]
 
You can also personalize the skin color, and look in this setup

==Miscellaneous==
On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
 
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the [[Variable substitution system]]

==ログインページ==
On this section, you can customize the login page with a message and a background image. In this message, you can use the [[Variable substitution system]]
 
It is also possible to hide/show the "'''Need help or support'''" link on login page

=メニューs=
[[File:Menu Setup.png|alt=Menu Setup|thumb|Menu Setup]]
Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus.
See page [[Menus system]] for more information.

==Menu handlers==
The software comes with two different menu handler :

*Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
*Auguria : It is a database menu manager. This menu can be fully customized to your needs.

In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.

==Menu Editor==
In this tab, you can customize each menu entry of '''auguria''' menu or the additional entries of '''eldy '''menu and create new entries

==Miscellaneous==
In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.

=その他 (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)=
Other entries in Setup menu are advanced options. You can ignore them if you want.

*[[Setup Translation]]
*[[Setup Default values/filters/sorting]]
*[[Setup Widgets]]
*[[Setup Alerts]]
*[[Setup Security]]
*[[Setup Limits and accuracy]]
*[[Setup PDF]]
*[[Setup EMails]]
*[[Setup SMS]]
*[[Setup Dictionnary|Setup Dictionary]]
*[[Setup Other]]

=利用者s=
The last step is to create users and assign permissions. Almost all the modules even activated earlier, are not accessible if you do not give permissions. To do this, you can go to the menu '''Home -> Users & Groups''' to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (see above). It is recommended to configure permissions after activating the modules you want to use. For certain actions, if you do not have the rights to do an action, Dolibarr will not show you the action. You might miss some useful or important features. '''To give rights to a user or yourself, if you are an administrator, go to Home -> Users & Groups, select the desired user, then click on its 'Permission' tab.'''

You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu [[Setup Security]].

=関連ビデオs=
Basic setup :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Configuration options :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

Visual setup : Darkmode :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">cdhWVmTg54U</youtube>

First setup

2023-11-21T07:00:42Z

Cin TAKE:

[[fr:Premiers_paramétrages]]
[[de:Grundeinstellungen]]
[[es:Primeras_configuraciones]]
[[zh:设置]]
[[ja:JA_First_setup]]


[[Category:Admin_en]]
{{TemplateDocUser}}

After completing the initial installation, you must configure parameters in Dolibarr to match your needs.

=Company/Organization=
The first mandatory step is to define your company/organization information. For this, from home page, choose menu "'''Home->Setup->Company/Organization'''" and add the information for your company/organization.

*'''Name:''' Name of your company/organization
*[[File:Logo size.jpg|thumb]]'''Logo:''' Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
*'''Logo (squared):''' Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
*'''Fiscal Year:''' Define your starting month of yiscal Year
*'''Country:''' Define your country: other options depend on this selection.

*'''Prof ID X:''' The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.

*'''Sales Tax (VAT) Management:''' Define how you manage Sales Tax (or not).
*'''Second type of tax:''' Define if you would like to use second type of taxe (or not).
*'''Third type of tax:''' Define if you would like to use third type of taxe (or not).

=Modules=
[[File:List of modules en.png|alt=List of modules|thumb|List of modules]]
The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.

To activate a module, go to page "'''Home->Setup->Modules'''" and click the button 'on/off' in the "Status" column to enable it.
*The module is '''on''' if the 'on/off' button is like [[File:On off button on.png|alt='on/off' button in on position|'on/off' button in on position]]
*The module is '''off''' if the 'on/off' button is like [[File:On off button off.png|alt='on/off' button in off position|'on/off' button in off position]]

The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].

If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.

Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See [[:Category:List of Modules|documentation of module]] for more information.

Related videos:

Modules:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Module settings:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

=Display=
[[File:Display settings EN.png|alt=Display settings|thumb|Display settings]]
On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.

==Language==
In the language settings, you can set the Default Language. By default it is set to "Auto Detect".
''Note:'' Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.

==Default skin theme==
In Dolibarr you have two different skins :
* eldy [[File:Eldy Theme thumb.png]]
* md [[File:Md theme thumb.png]]
More skins can be downloaded on the dolistore [https://www.dolistore.com/4-skins]
 
You can also personalize the skin color, and look in this setup

==Miscellaneous==
On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
 
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the [[Variable substitution system]]

==Login page==
On this section, you can customize the login page with a message and a background image. In this message, you can use the [[Variable substitution system]]
 
It is also possible to hide/show the "'''Need help or support'''" link on login page

=Menus=
[[File:Menu Setup.png|alt=Menu Setup|thumb|Menu Setup]]
Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus.
See page [[Menus system]] for more information.

==Menu handlers==
The software comes with two different menu handler :
* Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
* Auguria : It is a database menu manager. This menu can be fully customized to your needs.
In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.

==Menu Editor==
In this tab, you can customize each menu entry of '''auguria''' menu or the additional entries of '''eldy '''menu and create new entries

==Miscellaneous==
In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.

=Other (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)=
Other entries in Setup menu are advanced options. You can ignore them if you want.

*[[Setup Translation]]
*[[Setup Default values/filters/sorting]]
*[[Setup Widgets]]
*[[Setup Alerts]]
*[[Setup Security]]
*[[Setup Limits and accuracy]]
*[[Setup PDF]]
*[[Setup EMails]]
*[[Setup SMS]]
*[[Setup Dictionnary|Setup Dictionary]]
*[[Setup Other]]

=Users=
The last step is to create users and assign permissions. Almost all the modules even activated earlier, are not accessible if you do not give permissions. To do this, you can go to the menu '''Home -> Users & Groups''' to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (see above). It is recommended to configure permissions after activating the modules you want to use. For certain actions, if you do not have the rights to do an action, Dolibarr will not show you the action. You might miss some useful or important features. '''To give rights to a user or yourself, if you are an administrator, go to Home -> Users & Groups, select the desired user, then click on its 'Permission' tab.'''

You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu [[Setup Security]].

=Related videos=
Basic setup :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Configuration options :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

Visual setup : Darkmode :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">cdhWVmTg54U</youtube>

ホームページ

2023-11-21T06:49:23Z

Cin TAKE:

[[en:Home]]
[[fr:Accueil]]
[[es:Portada]]
[[de:Hauptseite]]
[[el:Αρχική]]
[[pt:Página Principal]]
[[zh:简体中文官方文档]]

{{DISPLAYTITLE:Easy to use Open-Source software for business}}
<center>
[[File:Dolibarr logo.png|180px|link=]]

'''Be free to manage your company, freelancer or foundation activity'''
</center>

このWikiには、Dolibarr ERP/CRMに関するすべての文章（ユーザー向け、開発者向け、翻訳者向けの文章）とリソースが含まれる。ダウンロードは、Dolibarrプロジェクトのウェブポータル（https://www.dolibarr.org）から可能。

{{Info}}{{InfoJa}}

=[[File:art.png|link=]] Dolibarrプロジェクト=

*[[JA_What_Dolibarr_Does|Dolibarrとは？]] - [[JA_FAQ_Who_uses_Dolibarr|Dolibarrのユーザは誰?]]
*[[Dolibarr Project|資料、経緯、プロジェクト組織]]
*[[Dolibarr foundation|Dolibarr 基金]]
*[https://www.dolibarr.org/onlinedemo オンラインデモ]
*[https://www.dolibarr.org/downloads/ ダウンロード]

=[[File:File_Doc_user.png|link=]] 利用者文書=

*[[User_documentation_JA|利用者手引き]] と [[User FAQ|利用者FAQ]]
*[https://www.youtube.com/playlist?list=PL317BA167DF5A1D3E ビデオ学習(英語)]
*[[Dolibarr help and support|ヘルプとサポートセンター]] (コミュニティフォーラム、有償サポート等)
*[[Screenshots|スクリーンショット]]
*[[Security informations|セキュリティ情報]]

=[[File:File_Doc_dev.png|link=]] 開発者文書=

*[[JA Developer documentation|開発者手引き]]
*[[JA Developer FAQ|開発者FAQ]]
*[[JA Dolibarr Project|資料、プロジェクト組織]]

=[[File:File_Doc_trans.png|link=]] 翻訳者文書=

*[[Translator documentation|翻訳者手引き]]

=[[File:File_Doc_tester.png|link=]] テスター文書=

*[[JA Tester documentation|テスター手引き]]

__NOTOC__
__NOEDITSECTION__

User documentation JA

2023-11-21T06:38:47Z

Cin TAKE:

=利用者手引き=

このページは利用者手引きに関連する主たる索引である。文書類の開発者は、[[JA Developer documentation|ここを参照]].

=特徴の速攻概説=

*[[What Dolibarr Do|Dolibarrとは何か, Dolibarrにできることは]]
*[[What Dolibarr can't do|Dolibarrと違うものは, Dolibarrにできないことは]]

=インストール | アップグレード | 設定=

*[[Prerequisite|前提条件]]
*[[Installation - Upgrade|インストール - アップグレード]]
*[[First setup|設定]]

Dolibarrの使用法は以下の章で提供する

=管理運営=

*マイグレーション: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

関連ビデオs:
(フランス語音声、字幕が利用可能)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=ダッシュボード=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=使用法 (於モジュールs / アプリs)=

Dolibarr の利用法を知ることはそのモジュールの利用法と特徴を知ること.
最初に, インストールステップが完了したら (前章参照), 利用法に関する一般的情報を見てみよう:

*[[General information on usage]] (First steps).

一般的利用法を理解したら, 標準的ビジネスモジュールに関する文章を見るとよい. 興味のあるモジュールを選択し、その文章を見よう. 標準的モジュールは、すべてのインストールにおいてデフォルトで利用可能なものである. これが主要モジュールのリスト (ページ [[:Category:List of Modules|List of Modules]] でも見れる) :

==人事管理 (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Document Generation''': Mass email document generation (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services
|-
| style="text-align:center;" |
|'''Call WebServices (SOAP client)''' : Enable the Dolibarr web services client (Can be used to push data/requests to external servers. Only Purchase orders are currently supported.) (Experimental)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]
[[Category:Page waiting for translation]]

Template:TemplateDocUserJa

2023-11-20T05:25:36Z

Cin TAKE:

<div class="wikibox">
[[User documentation JA|利用者手引き 索引に戻る]] 
[[File:File_Doc_user.png|link=User documentation JA]]
</div>

JA First setup

2023-11-20T05:24:00Z

Cin TAKE: start Japanese translation

{{TemplateDocUserJa}}

初回インストール後、自分の要件に合わせて Dolibarr のパラメータ設定をすること.

=法人/組織=
最初必須ステップは自分の法人/組織情報を定義すること. このため、ホームページから、メニュー選択 "'''ホーム->設定->法人/組織'''" して自分の法人/組織の情報を追加する.

*'''名:''' 自分の法人/組織の名前
*[[File:Logo size.jpg|thumb]]'''ロゴ:''' Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
*'''ロゴ (正方形):''' Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
*'''会計年度:''' 自分の会計開始月を定義
*'''国:''' Define your country: other options depend on this selection.

*'''職業分類ID X:''' The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.

*'''消費税(VAT)管理:''' Define how you manage Sales Tax (or not).
*'''2種目の税金:''' Define if you would like to use second type of taxe (or not).
*'''3種目の税金:''' Define if you would like to use third type of taxe (or not).

=モジュールs=
[[File:List of modules en.png|alt=List of modules|thumb|List of modules]]
The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.

To activate a module, go to page "'''Home->Setup->Modules'''" and click the button 'on/off' in the "Status" column to enable it.

*The module is '''on''' if the 'on/off' button is like [[File:On off button on.png|alt='on/off' button in on position|'on/off' button in on position]]
*The module is '''off''' if the 'on/off' button is like [[File:On off button off.png|alt='on/off' button in off position|'on/off' button in off position]]

The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].

If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.

Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See [[:Category:List of Modules|documentation of module]] for more information.

Related videos:

Modules:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Module settings:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

=表示=
[[File:Display settings EN.png|alt=Display settings|thumb|Display settings]]
On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.

==言語==
In the language settings, you can set the Default Language. By default it is set to "Auto Detect".
''Note:'' Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.

==Default skin theme==
In Dolibarr you have two different skins :

*eldy [[File:Eldy Theme thumb.png]]
*md [[File:Md theme thumb.png]]

More skins can be downloaded on the dolistore [https://www.dolistore.com/4-skins]
 
You can also personalize the skin color, and look in this setup

==Miscellaneous==
On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
 
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the [[Variable substitution system]]

==ログインページ==
On this section, you can customize the login page with a message and a background image. In this message, you can use the [[Variable substitution system]]
 
It is also possible to hide/show the "'''Need help or support'''" link on login page

=メニューs=
[[File:Menu Setup.png|alt=Menu Setup|thumb|Menu Setup]]
Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus.
See page [[Menus system]] for more information.

==Menu handlers==
The software comes with two different menu handler :

*Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
*Auguria : It is a database menu manager. This menu can be fully customized to your needs.

In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.

==Menu Editor==
In this tab, you can customize each menu entry of '''auguria''' menu or the additional entries of '''eldy '''menu and create new entries

==Miscellaneous==
In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.

=その他 (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)=
Other entries in Setup menu are advanced options. You can ignore them if you want.

*[[Setup Translation]]
*[[Setup Default values/filters/sorting]]
*[[Setup Widgets]]
*[[Setup Alerts]]
*[[Setup Security]]
*[[Setup Limits and accuracy]]
*[[Setup PDF]]
*[[Setup EMails]]
*[[Setup SMS]]
*[[Setup Dictionnary|Setup Dictionary]]
*[[Setup Other]]

=利用者s=
The last step is to create users and assign permissions. Almost all the modules even activated earlier, are not accessible if you do not give permissions. To do this, you can go to the menu '''Home -> Users & Groups''' to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (see above). It is recommended to configure permissions after activating the modules you want to use. For certain actions, if you do not have the rights to do an action, Dolibarr will not show you the action. You might miss some useful or important features. '''To give rights to a user or yourself, if you are an administrator, go to Home -> Users & Groups, select the desired user, then click on its 'Permission' tab.'''

You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu [[Setup Security]].

=関連ビデオs=
Basic setup :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Configuration options :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

Visual setup : Darkmode :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">cdhWVmTg54U</youtube>

Template:TemplateDocUserJa

2023-11-20T04:11:40Z

Cin TAKE: 日本語翻訳

<div class="wikibox">
[[User documentation JA|Return to user documentation index]] 
[[File:File_Doc_user.png|link=User documentation JA]]
</div>

User documentation JA

2023-11-20T03:27:49Z

Cin TAKE: 日本語翻訳開始

=利用者手引き=

このページは利用者手引きに関連する主たる索引である。文書類の開発者は、[[JA Developer documentation|ここを参照]].

=特徴の速攻概説=

*[[What Dolibarr Do|Dolibarrとは何か, Dolibarrにできることは]]
*[[What Dolibarr can't do|Dolibarrと違うものは, Dolibarrにできないことは]]

=インストール | アップグレード | 設定=

*[[Prerequisite|前提条件]]
*[[Installation - Upgrade|インストール - アップグレード]]
*[[First setup|設定]]

Dolibarrの使用法は以下の章で提供する

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Module_Scheduled_jobs|Scheduled Jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=ダッシュボード=

Related videos:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=使用法 (by modules / applications)=

Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]) :

==人事管理 (HR)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Users|Users & Groups]]''' : Users / Employees and Groups management
|-
| style="text-align:center;" |
|'''[[Module Membership management|Members]]''' : Foundation members management
|-
| style="text-align:center;" |
|'''[[Module Leaves|Leave Request Management]]''' : Define and track employee leave requests
|-
| style="text-align:center;" |
|'''[[Module Expense Reports|Expense Reports]]''' : Manage expense reports claims (transportation, meal, ...)
|-
| style="text-align:center;" |
|'''Recruitment ''' : Manage and follow recruitment campaigns for new job positions
|-
| style="text-align:center;" |
|'''[[Module HRM|HRM]]''' : Human resources management (management of department, employee contracts and feelings)
|}

==Customer Relationship Management (CRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Third Parties|Third Parties]]''' : Companies and contacts management (customers, prospects...)
|-
| style="text-align:center;" |
|'''[[Module Commercial Proposals - Quotes|Proposals]]''' : Commercial proposal management
|-
| style="text-align:center;" |
|'''[[Module Sales Orders|Sales Orders]]''' : Sales order management
|-
| style="text-align:center;" |
|'''[[Module Shipments|Shipments]]''' : Shipments and delivery note management
|-
| style="text-align:center;" |
|'''[[Module Contracts|Contracts/Subscriptions]]''' : Management of contracts (services or recurring subscriptions)
|-
| style="text-align:center;" |
|'''[[Module Interventions En|Interventions]]''' : Intervention management
|-
| style="text-align:center;" |
|'''[[Module Ticket|Tickets]]''' : Ticket system for issue or request management
|-
| style="text-align:center;" |
|'''[[Module Knowledge Management|Knowledge Management System]]''' : Manage a Knowledge Management (KM) or Help-Desk base
|-
| style="text-align:center;" |
|'''Partnership Management''' : Module Partnership management
|}

==Vendor Relationship Management (VRM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Suppliers Orders|Vendors]]''' : Vendors and purchase management (purchase orders and billing of supplier invoices)
|-
| style="text-align:center;" |
|'''Vendor Commercial Proposals''' : Request vendor commercial proposal and prices
|-
| style="text-align:center;" |
|'''Reception''' : Vendor reception management (Create reception documents)
|-
| style="text-align:center;" |
|'''Incoterms''' : Add features to manage Incoterms
|}

==Financial Modules (Accounting/Treasury)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Invoice|Invoices]]''' : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers
|-
| style="text-align:center;" |
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]''' : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...)
|-
| style="text-align:center;" |
|'''Salaries''' : Record and track employee payments
|-
| style="text-align:center;" |
|'''Loans''' : Management of loans
|-
| style="text-align:center;" |
|'''[[Module Donations|Donations]]''' : Donation management
|-
| style="text-align:center;" |
|'''[[Module Banks and Cash|Banks & Cash]]''' : Management of bank or cash accounts
|-
| style="text-align:center;" |
|'''Payment By Credit Transfer''' : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Standing Orders|Payment By Direct Debit]]''' : Management of Direct Debit orders. It includes generation of SEPA file for European countries.
|-
| style="text-align:center;" |
|'''[[Module Margins|Margins]]''' : Module to follow margins
|-
| style="text-align:center;" |
|'''[[Module Accounting Simplified|Accounting (simplified)]]''' : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table.
|-
| style="text-align:center;" |
|'''[[Module Double Entry Accounting|Accounting (double entry)]]''' : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats.
|-
| style="text-align:center;" |
|'''Intracomm report''' : Intracomm report management (Support for French DEB/DES format) (Experimental)
|-
| style="text-align:center;" |
|'''Asset''' : Asset module (In Development)
|}

==Product Management (PM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Products|Products]]''' : Management of Products
|-
| style="text-align:center;" |
|'''[[Module Services En|Services]]''' : Management of Services
|-
| style="text-align:center;" |
|'''[[Module Stocks En|Stocks]]''' : Stock management
|-
| style="text-align:center;" |
|'''[[Module Lot / Serial|Product Lots]]''' : Lots, serial numbers, eat-by/sell-by date management for products
|-
| style="text-align:center;" |
|'''Product Variants''' : Creation of product variants (color, size etc.)
|-
| style="text-align:center;" |
|'''[[Module BOM|Bills of Material]]''' : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Manufacturing Orders|Manufacturing Orders]]''' : Module to Manage Manufacturing Orders (MO)
|-
| style="text-align:center;" |
|'''[[Module Dynamic Prices|Dynamic Prices]]''' : Use maths expressions for auto-generation of prices (Experimental)
|-
| style="text-align:center;" |
|'''[[Module Workstation|Workstation]]''' : Workstations management (In Development)
|}

==Projects/Collaborative work==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Projects|Projects or Leads]]''' : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view.
|-
| style="text-align:center;" |
|'''[[Module Agenda En|Events/Agenda]]''' : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management.
|-
| style="text-align:center;" |
|'''[[Module Resources|Resources]]''' : Manage resources (printers, cars, rooms, ...) for allocating to events
|-
| style="text-align:center;" |
|'''[[Module Event Organization|Event Organization]]''' : Event Organization through Module Project
|}

==Electronic Content Management (ECM)==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''DMS / ECM''' : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them when you need.
|}

==Multi-modules tools==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Categories|Tags / Categories]]''' : Create tags/category (products, customers, suppliers, contacts or members)
|-
| style="text-align:center;" |
|'''WYSIWYG Editor''' : Allow text fields to be edited/formatted using CKEditor (html)
|-
| style="text-align:center;" |
|'''Multicurrency''' : Use alternative currencies in prices and documents
|-
| style="text-align:center;" |
|'''RSS Feed''' : Add a RSS feed to Dolibarr pages
|-
| style="text-align:center;" |
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]''' : Create shortcuts, always accessible, to the internal or external pages to which you frequently access
|-
| style="text-align:center;" |
|'''[[Module Barcode|Barcodes]]''' : Barcode or QR code management
|-
| style="text-align:center;" |
|'''[[Module Workflow En|Inter-modules Workflow]]''' : Workflow management between different modules (automatic creation of object and/or automatic status change)
|-
| style="text-align:center;" |
|'''[[Module Imports En|Data imports]]''' : Tool to import data into Dolibarr (with assistance)
|-
| style="text-align:center;" |
|'''[[Module Exports En|Data exports]]''' : Tool to export Dolibarr data (with assistance)
|-
| style="text-align:center;" |
|'''Stickers''' : Management of stickers (In Development)
|-
| style="text-align:center;" |
|'''Document Generation''': Mass email document generation (In Development)
|-
| style="text-align:center;" |
|'''Data Privacy Policy''' : Module to manage Data Privacy (Conformity with the GDPR) (Experimental)
|-
| style="text-align:center;" |
|'''[[Module ModuleBuilder|Module and Application Builder]]''' : A RAD (Rapid Application Development) tool to help developers to build their own module.
|}

==Websites and other frontal application==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Poll, Survey or Vote''' : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...)
|-
| style="text-align:center;" |
|'''[[Module Website|Websites]]''' : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name.
|-
| style="text-align:center;" |
|'''Collab''' : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development)
|-
| style="text-align:center;" |
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]''' : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants).
|}

==Interfaces with external systems==

{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Social Networks''' : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...).
|-
| style="text-align:center;" |
|'''[[Module Notification|Notifications on business event]]''' : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails
|-
| style="text-align:center;" |
|'''[[Module EMailing|Mass Emailings]]''' : Manage bulk emailing
|-
| style="text-align:center;" |
|'''[[Module EMail Collector|Email collector]]''' : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads).
|-
| style="text-align:center;" |
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]''' : Enable the Dolibarr REST server providing API services
|-
| style="text-align:center;" |
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]''' : Enable the Dolibarr SOAP server providing API services
|-
| style="text-align:center;" |
|'''Call WebServices (SOAP client)''' : Enable the Dolibarr web services client (Can be used to push data/requests to external servers. Only Purchase orders are currently supported.) (Experimental)
|-
| style="text-align:center;" |[[File:Object zapier.png]]
|'''[[Module Zapier|Zapier]]''' : Interface with Zapier (In Development)
|-
| style="text-align:center;" |
|'''[[Module LDAP En|LDAP]]''' : LDAP directory synchronization
|-
| style="text-align:center;" |
|'''[[Module OAuth|OAuth]]''' : Enable OAuth authentication
|-
| style="text-align:center;" |
|'''External Site''' : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu.
|-
| style="text-align:center;" |
|'''[[Module FTP En|FTP]]''' : FTP Client
|-
| style="text-align:center;" |[[File:IP address icon.png|frameless|32px]]
|'''GeoIPMaxmind''' : GeoIP Maxmind conversions capabilities
|-
| style="text-align:center;" |[[File:Object paybox.png|frameless|32px]]
|'''PayBox''' : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |[[File:Object paypal.png|frameless|32px]]
|'''[[Module PayPal En|Paypal]]''' : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module Stripe|Stripe]]''' : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...)
|-
| style="text-align:center;" |
|'''[[Module ClickToDial En|ClickToDial]]''' : Integration of a ClickToDial system (Asterisk, ...)
|-
| style="text-align:center;" |
|'''One click Printing''' : Enable One click Printing System
|-
| style="text-align:center;" |
|'''Receipt printers''' : Setup of receipt printers
|-
| style="text-align:center;" |
|'''Mailman and SPIP''' : Mailman or SPIP interface for member module
|-
| style="text-align:center;" |[[File:Object gravatar.png|frameless|32px]]
|'''Gravatar''' : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access
|-
| style="text-align:center;" |
|'''[[Module DAV|Dav]]''' : Setup a WebDAV server
|-
| style="text-align:center;" |
|'''[[Module Webhook|Webhook]]''' : Interface to catch dolibarr triggers and send it to an URL
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''[[Module Scheduled jobs|Scheduled jobs]]''' : Scheduled jobs management (alias cron or chrono table)
|-
| style="text-align:center;" |
|'''Debug Logs''' : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes
|-
| style="text-align:center;" |
|'''Debug Bar''' : A tool for developper adding a debug bar in your browser.
|-
| style="text-align:center;" |
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]''' : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries.
|}

==System==
{| style="margin-left: 20px; margin-right: auto;"
| style="text-align:center;" |
|'''Advanced Stock Transfer''' : Advanced management of Stock Transfer, with generation of transfer sheet (In Development)
|}

==External Modules==
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]

=Video Tutorials=
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]]

[[Category:Proofreading done]]

ホームページ

2023-11-20T03:14:47Z

Cin TAKE:

[[en:Home]]
[[fr:Accueil]]
[[es:Portada]]
[[de:Hauptseite]]
[[el:Αρχική]]
[[pt:Página Principal]]
[[zh:简体中文官方文档]]

{{DISPLAYTITLE:Easy to use Open-Source software for business}}
<center>
[[File:Dolibarr logo.png|180px|link=]]

'''Be free to manage your company, freelancer or foundation activity'''
</center>

このWikiには、Dolibarr ERP/CRMに関するすべてのドキュメント（ユーザー向け、開発者向け、翻訳者向けのドキュメント）とリソースが含まれています。ダウンロードは、Dolibarrプロジェクトのウェブポータル（https://www.dolibarr.org）から可能です。

{{Info}}{{InfoJa}}

=[[File:art.png|link=]] Dolibarrプロジェクト=

*[[JA_What_Dolibarr_Does|Dolibarrとは？]] - [[JA_FAQ_Who_uses_Dolibarr|Dolibarrのユーザは誰?]]
*[[Dolibarr Project|資料、経緯、プロジェクト組織]]
*[[Dolibarr foundation|Dolibarr 基金]]
*[https://www.dolibarr.org/onlinedemo オンラインデモ]
*[https://www.dolibarr.org/downloads/ ダウンロード]

=[[File:File_Doc_user.png|link=]] 利用者文書=

*[[User_documentation_JA|利用者手引き]] と [[User FAQ|利用者FAQ]]
*[https://www.youtube.com/playlist?list=PL317BA167DF5A1D3E ビデオ学習(英語)]
*[[Dolibarr help and support|ヘルプとサポートセンター]] (コミュニティフォーラム、有償サポート等)
*[[Screenshots|スクリーンショット]]
*[[Security informations|セキュリティ情報]]

=[[File:File_Doc_dev.png|link=]] 開発者文書=

*[[JA Developer documentation|開発者手引き]]
*[[JA Developer FAQ|開発者FAQ]]
*[[JA Dolibarr Project|資料、プロジェクト組織]]

=[[File:File_Doc_trans.png|link=]] 翻訳者文書=

*[[Translator documentation|翻訳者手引き]]

=[[File:File_Doc_tester.png|link=]] テスター文書=

*[[JA Tester documentation|テスター手引き]]

__NOTOC__
__NOEDITSECTION__

Category:Page waiting for translation

2023-11-20T03:05:56Z

Cin TAKE: Add Janaese description

{{flag_en}} Index of pages waiting for translation (english, french, spanish or italian).

{{flag_fr}} Index des pages en attentes de traduction (anglais, français, espagnol ou italien).

{{flag_sp}} Indice de páginas en espera de traducción (inglés, francés, español o italiano).

{{flag_it}} Indice delle pagine in attesa di traduzione (inglese, francese, spagnolo o italiano).

{{flag_pt}} Índex das páginas a aguardar por tradução (inglês, francês, espanhol ou italiano).

{{flag_zh}} 等待翻译的页面索引（中文、英文、法文、西班牙文或意大利文）。

{{Flag jp}} 翻訳待ちページの索引 (日本語、英語、仏語、西語、伊語)

モジュール開発

2023-08-26T07:51:08Z

Cin TAKE: /* Database access */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分からなる．

*Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
{{TemplateModuleTabsJA}}

*Part 2: タブのコードで、タブの追加（+で始まる）または削除（-で始まる）を識別する．
*Part 3: タブのタイトル．タイトルが読みずらいなら、コードにして言語ファイルで翻訳するとよい．
*Part 4: ファイル名 "*.lang" は、コード翻訳と表示する言語の対応を含む．この名前の後に@mymoduleが続く場合、 Dolibarrはモジュール内の翻訳ファイル "*.lang "を検索するので、htdocs/mymodule/langs/code_CODE/mylangfile.langとなり、そうでない場合はhtdocs/langs/code_CODE/mylangfile.langとなる．
*Part 5: タブを常時表示すべきかのテスト条件．常時表示の場合は1を指定．
*Part 6: タブをクリックしたときに表示されるページのURL。__ID__の文字列は自動的に当該要素のIdに置き換えられる．

タブの内容へデータベースからのデータを注入するには、次章を参照．

既存タブの名前 'tabname' を取得するには、ファイル 'core/lib/module.lib.php' の関数 'product_prepare_head' で使用されている名前で、セクション '$head[$h][2]' に対応するものをチェックする必要がある．

===自前ページにタブナビゲーションを表示===
'''使用場面''': 自前ページにオブジェクト(製品、階層、など)の標準タブを表示したい

以下の手順に従う :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.

そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
ご覧のように、main.inc.php（または master.inc.php）のロードは何回か試行される。目標は、大抵のケースで成功すること。最小は2行: master/main.inc.phpをdolibarrルートディレクトリにロードしようとする行と、モジュールが "custom "ディレクトリにデプロイされるケースをサポートするためにファイルをロードしようとする行。しかし、より多くの状況に対応するため、より多くを持つことができる。提供された例は、ほぼすべての状況/セットアップで main/master.inc.php ファイルをロードできるはず。

注意：モジュール・ディレクトリ・ツリーに対するファイルの深さによっては、さらに"../"を追加する。

main.inc.phpファイルでは、技術上の環境変数とパーミッションを読み込む。以下の変数はこのファイルに配置されているオブジェクト：

*$user ユーザーの特徴とパーミッションを保持するオブジェクト。
*$conf Dolibarrの設定を保持するオブジェクト
*$db データベースへのオープンされた接続ハンドラを保持するオブジェクト。
*$langs ユーザー言語を保持するオブジェクト。

次にページを表示するために自前コードを入力する.

*モジュール専用クラスやライブラリをインクルードするには、（include_onceを直接使わず）Dolibarr関数を使う：

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*Dolibarrで提供されているクラスをインクルードするには、以下の構文を使う:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===データベースアクセス===
自前テーブルの中でデータベースのデータを編集する必要がある場合、前に生成されたPHPクラスを使うこと。

専用の PHP クラスがないテーブルにアクセスしたい場合 (たとえば、特定の結合やフィルタを使用したレコードの一覧を取得したい場合など) 、これはいつでも可能。この場合に、倣うべきコード例は：

操作が、 insert, update または delete:

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

操作が read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-08-26T07:40:19Z

Cin TAKE: /* PHP 画面の作成や更新 (任意) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分からなる．

*Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
{{TemplateModuleTabsJA}}

*Part 2: タブのコードで、タブの追加（+で始まる）または削除（-で始まる）を識別する．
*Part 3: タブのタイトル．タイトルが読みずらいなら、コードにして言語ファイルで翻訳するとよい．
*Part 4: ファイル名 "*.lang" は、コード翻訳と表示する言語の対応を含む．この名前の後に@mymoduleが続く場合、 Dolibarrはモジュール内の翻訳ファイル "*.lang "を検索するので、htdocs/mymodule/langs/code_CODE/mylangfile.langとなり、そうでない場合はhtdocs/langs/code_CODE/mylangfile.langとなる．
*Part 5: タブを常時表示すべきかのテスト条件．常時表示の場合は1を指定．
*Part 6: タブをクリックしたときに表示されるページのURL。__ID__の文字列は自動的に当該要素のIdに置き換えられる．

タブの内容へデータベースからのデータを注入するには、次章を参照．

既存タブの名前 'tabname' を取得するには、ファイル 'core/lib/module.lib.php' の関数 'product_prepare_head' で使用されている名前で、セクション '$head[$h][2]' に対応するものをチェックする必要がある．

===自前ページにタブナビゲーションを表示===
'''使用場面''': 自前ページにオブジェクト(製品、階層、など)の標準タブを表示したい

以下の手順に従う :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.

そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
ご覧のように、main.inc.php（または master.inc.php）のロードは何回か試行される。目標は、大抵のケースで成功すること。最小は2行: master/main.inc.phpをdolibarrルートディレクトリにロードしようとする行と、モジュールが "custom "ディレクトリにデプロイされるケースをサポートするためにファイルをロードしようとする行。しかし、より多くの状況に対応するため、より多くを持つことができる。提供された例は、ほぼすべての状況/セットアップで main/master.inc.php ファイルをロードできるはず。

注意：モジュール・ディレクトリ・ツリーに対するファイルの深さによっては、さらに"../"を追加する。

main.inc.phpファイルでは、技術上の環境変数とパーミッションを読み込む。以下の変数はこのファイルに配置されているオブジェクト：

*$user ユーザーの特徴とパーミッションを保持するオブジェクト。
*$conf Dolibarrの設定を保持するオブジェクト
*$db データベースへのオープンされた接続ハンドラを保持するオブジェクト。
*$langs ユーザー言語を保持するオブジェクト。

次にページを表示するために自前コードを入力する.

*モジュール専用クラスやライブラリをインクルードするには、（include_onceを直接使わず）Dolibarr関数を使う：

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*Dolibarrで提供されているクラスをインクルードするには、以下の構文を使う:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Module Web Services API REST (developer) JA

2023-07-24T10:17:22Z

Cin TAKE: /* Installation */

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

=機能=
このモジュールを有効化すると、Dolibarrサーバが提供するウェブサービスを利用可能にできる. そこから、Dolibarrが提供する別のウェブサービスに REST 呼出しを実行することもできる.

=インストール=

インストールするには, モジュールページを開いて "API REST" モジュールを有効化する.

一旦モジュール webservices REST が有効化されると, Dolibarr も REST web services サーバとなる. なので、自前の REST リクエストが可能：相対 URL
'''/api/index.php/xxx''' ここで xxx は呼び出す API の名称.

自前でインストールした API 一覧はエクスプローラを通じて検索可能. エクスプローラへのリンクをクリックして API エクスプローラを開く.

==Apache 設定==
設定は不要. 自前の Dolibarr が Apache で動作中なら, REST API も動作するはず. API は自前アプリと同じ仮想サーバにて動作する.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience such troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

<syntaxhighlight lang="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</syntaxhighlight>

=List of provided services=
Only few services are available. You can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.
If you prefer, you can first make a first call to the '''login''' API to get the API token key. Then enter API key to get list of all other available API services.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

You can then test directly from the explorer tool any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

=Use=

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

Before using any API, you must first get a custom API-key. You have to create a new user and generate or set its "Key for API".

[[File:Dolibarr user for api.png|400px]]

You will have to use this API key in any of your client program that need to call a Dolibarr API.

==Client code example==

===PHP===
There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<syntaxhighlight lang="PHP">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</syntaxhighlight>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :

*$method : string, "GET", "POST", "PUT", "DELETE"
*$apikey : string, "your <token> generated earlier"
*$url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
*$data : string, datas in json format. This parameter is not mandatory.

===Javascript Ajax===

<syntaxhighlight lang="javascript">
<script>
$.ajax({
type: 'GET',
async: true,
contentType: "application/json; charset=utf-8",
data: { 'lang': 'en_US' },
dataType: "json",
cache: false,
jsonp: false,
headers: {
'DOLAPIKEY': 'abcdef123456'
},
url: 'https://myserver/api/index.php/theapi',
success: function(rep) {
console.log("API call success");
console.log(rep);
},
error: function(rep) {
console.log("API call error");
console.log(rep);
}
});
</script>
</syntaxhighlight>

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

===sqlfilters===
They are passed on to the database after a check.
These work on the product endpoint:

*(t.fk_product_type: = :'0') and (t.tosell: = :'1') and (t.label: ilike :'%string')

===Date===
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

=Examples with PHP=

This is more examples, for different uses cases:

In every examples, we have:

*$apiKey = "<my token>";
*$apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<syntaxhighlight lang="PHP">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxhighlight>
Comments :

*I retrieve the 10'000 first products sorted on their ID in the base
*html_entity_decode is necessary as single quotes are encoded
*It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<syntaxhighlight lang="PHP">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxhighlight>
Comments :

*before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<syntaxhighlight lang="PHP">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxhighlight>
Comments :

*I check if the ref of my product exist in the array created in the first example.
*If it exists, I use it's key in the array as ID
*If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
*I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<syntaxhighlight lang="PHP">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxhighlight>
Comments :

*$clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
*type => 0, This is a customer order (while 1 = supplier order)

<syntaxhighlight lang="PHP">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</syntaxhighlight>
Comments :

*in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 

$newCommandeResult is the ID of the order created in the previous example

<syntaxhighlight lang="PHP">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</syntaxhighlight>
Comments :

*limit => 1 only 1 customer
*mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
*sqlfilters a bit special but there are more examples on the explorer page

<syntaxhighlight lang="PHP">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxhighlight>
Comments :

*client => 1 He is a customer (not a supplier)
*code_client => -1 so the customer code will be generated automatically.
*we get the customer ID in $clientDoliId

=Examples with Python=
See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

First you can install the python-module with "pip install dolibarr".

<syntaxhighlight lang="python">
from dolibarr import Dolibarr

api_url = '<nowiki>http://your-url/dolibarr/htdocs/api/index.php/'</nowiki>
api_key = 'custom_API-Key'

# Connection to dolibarr
dolibarr_inst = Dolibarr(api_url, api_key)

# create Product
params = {'ref': 'Product_Reference', 'status': '1', 'barcode_type': '6', 'note_public': None,

'note_private': <nowiki>''</nowiki>, 'specimen': 0, 'label': 'Product_Label',

'description': <nowiki>''</nowiki>, 'type': '0', 'price': <nowiki>''</nowiki>, 'price_ttc': '15.6000000', 'price_base_type': 'TTC', # excl. tax = HT, incl. tax = TTC

'tva_tx': '19.0000', 'seuil_stock_alerte': '0', 'desiredstock': '0', 'status_buy': '1', 'barcode': 'barcode'}

ret_val = dolibarr_inst.call_create_api('products', params)
print(ret_val)

# get product list
product_dict = dolibarr_inst.call_list_api('products')
print(product_dict)
</syntaxhighlight>

=Develop your own service / API=
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You can take an example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, this file may be generated for you.

The framework detects automatically the API files and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

To find all existing API files in Dolibarr, you can search all files htdocs/<directory>/class/api_xxx_class.php

Module Web Services API REST (developer) JA

2023-07-24T05:51:33Z

Cin TAKE: /* Function */

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

=機能=
このモジュールを有効化すると、Dolibarrサーバが提供するウェブサービスを利用可能にできる. そこから、Dolibarrが提供する別のウェブサービスに REST 呼出しを実行することもできる.

=Installation=

To install, open the modules page and activate de "API REST" module.

Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer. Click on link to explorer to open the API explorer.

==Apache setup==
There is nothing to do. If your Dolibarr is working with Apache, the REST API should also work. APIs will be served by the same virtual web server than your application.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience such troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

<syntaxhighlight lang="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</syntaxhighlight>

=List of provided services=
Only few services are available. You can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.
If you prefer, you can first make a first call to the '''login''' API to get the API token key. Then enter API key to get list of all other available API services.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

You can then test directly from the explorer tool any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

=Use=

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

Before using any API, you must first get a custom API-key. You have to create a new user and generate or set its "Key for API".

[[File:Dolibarr user for api.png|400px]]

You will have to use this API key in any of your client program that need to call a Dolibarr API.

==Client code example==

===PHP===
There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<syntaxhighlight lang="PHP">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</syntaxhighlight>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :

*$method : string, "GET", "POST", "PUT", "DELETE"
*$apikey : string, "your <token> generated earlier"
*$url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
*$data : string, datas in json format. This parameter is not mandatory.

===Javascript Ajax===

<syntaxhighlight lang="javascript">
<script>
$.ajax({
type: 'GET',
async: true,
contentType: "application/json; charset=utf-8",
data: { 'lang': 'en_US' },
dataType: "json",
cache: false,
jsonp: false,
headers: {
'DOLAPIKEY': 'abcdef123456'
},
url: 'https://myserver/api/index.php/theapi',
success: function(rep) {
console.log("API call success");
console.log(rep);
},
error: function(rep) {
console.log("API call error");
console.log(rep);
}
});
</script>
</syntaxhighlight>

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

===sqlfilters===
They are passed on to the database after a check.
These work on the product endpoint:

*(t.fk_product_type: = :'0') and (t.tosell: = :'1') and (t.label: ilike :'%string')

===Date===
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

=Examples with PHP=

This is more examples, for different uses cases:

In every examples, we have:

*$apiKey = "<my token>";
*$apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<syntaxhighlight lang="PHP">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxhighlight>
Comments :

*I retrieve the 10'000 first products sorted on their ID in the base
*html_entity_decode is necessary as single quotes are encoded
*It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<syntaxhighlight lang="PHP">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxhighlight>
Comments :

*before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<syntaxhighlight lang="PHP">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxhighlight>
Comments :

*I check if the ref of my product exist in the array created in the first example.
*If it exists, I use it's key in the array as ID
*If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
*I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<syntaxhighlight lang="PHP">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxhighlight>
Comments :

*$clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
*type => 0, This is a customer order (while 1 = supplier order)

<syntaxhighlight lang="PHP">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</syntaxhighlight>
Comments :

*in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 

$newCommandeResult is the ID of the order created in the previous example

<syntaxhighlight lang="PHP">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</syntaxhighlight>
Comments :

*limit => 1 only 1 customer
*mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
*sqlfilters a bit special but there are more examples on the explorer page

<syntaxhighlight lang="PHP">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxhighlight>
Comments :

*client => 1 He is a customer (not a supplier)
*code_client => -1 so the customer code will be generated automatically.
*we get the customer ID in $clientDoliId

=Examples with Python=
See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

First you can install the python-module with "pip install dolibarr".

<syntaxhighlight lang="python">
from dolibarr import Dolibarr

api_url = '<nowiki>http://your-url/dolibarr/htdocs/api/index.php/'</nowiki>
api_key = 'custom_API-Key'

# Connection to dolibarr
dolibarr_inst = Dolibarr(api_url, api_key)

# create Product
params = {'ref': 'Product_Reference', 'status': '1', 'barcode_type': '6', 'note_public': None,

'note_private': <nowiki>''</nowiki>, 'specimen': 0, 'label': 'Product_Label',

'description': <nowiki>''</nowiki>, 'type': '0', 'price': <nowiki>''</nowiki>, 'price_ttc': '15.6000000', 'price_base_type': 'TTC', # excl. tax = HT, incl. tax = TTC

'tva_tx': '19.0000', 'seuil_stock_alerte': '0', 'desiredstock': '0', 'status_buy': '1', 'barcode': 'barcode'}

ret_val = dolibarr_inst.call_create_api('products', params)
print(ret_val)

# get product list
product_dict = dolibarr_inst.call_list_api('products')
print(product_dict)
</syntaxhighlight>

=Develop your own service / API=
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You can take an example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, this file may be generated for you.

The framework detects automatically the API files and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

To find all existing API files in Dolibarr, you can search all files htdocs/<directory>/class/api_xxx_class.php

Module Web Services API REST (developer) JA

2023-07-24T05:18:50Z

Cin TAKE: Copied from EN version.

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

=Function=
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

=Installation=

To install, open the modules page and activate de "API REST" module.

Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer. Click on link to explorer to open the API explorer.

==Apache setup==
There is nothing to do. If your Dolibarr is working with Apache, the REST API should also work. APIs will be served by the same virtual web server than your application.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience such troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

<syntaxhighlight lang="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</syntaxhighlight>

=List of provided services=
Only few services are available. You can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.
If you prefer, you can first make a first call to the '''login''' API to get the API token key. Then enter API key to get list of all other available API services.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

You can then test directly from the explorer tool any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

=Use=

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

Before using any API, you must first get a custom API-key. You have to create a new user and generate or set its "Key for API".

[[File:Dolibarr user for api.png|400px]]

You will have to use this API key in any of your client program that need to call a Dolibarr API.

==Client code example==

===PHP===
There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<syntaxhighlight lang="PHP">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</syntaxhighlight>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :

*$method : string, "GET", "POST", "PUT", "DELETE"
*$apikey : string, "your <token> generated earlier"
*$url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
*$data : string, datas in json format. This parameter is not mandatory.

===Javascript Ajax===

<syntaxhighlight lang="javascript">
<script>
$.ajax({
type: 'GET',
async: true,
contentType: "application/json; charset=utf-8",
data: { 'lang': 'en_US' },
dataType: "json",
cache: false,
jsonp: false,
headers: {
'DOLAPIKEY': 'abcdef123456'
},
url: 'https://myserver/api/index.php/theapi',
success: function(rep) {
console.log("API call success");
console.log(rep);
},
error: function(rep) {
console.log("API call error");
console.log(rep);
}
});
</script>
</syntaxhighlight>

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

===sqlfilters===
They are passed on to the database after a check.
These work on the product endpoint:

*(t.fk_product_type: = :'0') and (t.tosell: = :'1') and (t.label: ilike :'%string')

===Date===
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

=Examples with PHP=

This is more examples, for different uses cases:

In every examples, we have:

*$apiKey = "<my token>";
*$apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<syntaxhighlight lang="PHP">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxhighlight>
Comments :

*I retrieve the 10'000 first products sorted on their ID in the base
*html_entity_decode is necessary as single quotes are encoded
*It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<syntaxhighlight lang="PHP">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxhighlight>
Comments :

*before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<syntaxhighlight lang="PHP">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxhighlight>
Comments :

*I check if the ref of my product exist in the array created in the first example.
*If it exists, I use it's key in the array as ID
*If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
*I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<syntaxhighlight lang="PHP">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxhighlight>
Comments :

*$clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
*type => 0, This is a customer order (while 1 = supplier order)

<syntaxhighlight lang="PHP">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</syntaxhighlight>
Comments :

*in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 

$newCommandeResult is the ID of the order created in the previous example

<syntaxhighlight lang="PHP">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</syntaxhighlight>
Comments :

*limit => 1 only 1 customer
*mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
*sqlfilters a bit special but there are more examples on the explorer page

<syntaxhighlight lang="PHP">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxhighlight>
Comments :

*client => 1 He is a customer (not a supplier)
*code_client => -1 so the customer code will be generated automatically.
*we get the customer ID in $clientDoliId

=Examples with Python=
See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

First you can install the python-module with "pip install dolibarr".

<syntaxHighlight lang=python>
from dolibarr import Dolibarr

api_url = '<nowiki>http://your-url/dolibarr/htdocs/api/index.php/'</nowiki>
api_key = 'custom_API-Key'

# Connection to dolibarr
dolibarr_inst = Dolibarr(api_url, api_key)

# create Product
params = {'ref': 'Product_Reference', 'status': '1', 'barcode_type': '6', 'note_public': None,

'note_private': <nowiki>''</nowiki>, 'specimen': 0, 'label': 'Product_Label',

'description': <nowiki>''</nowiki>, 'type': '0', 'price': <nowiki>''</nowiki>, 'price_ttc': '15.6000000', 'price_base_type': 'TTC', # excl. tax = HT, incl. tax = TTC

'tva_tx': '19.0000', 'seuil_stock_alerte': '0', 'desiredstock': '0', 'status_buy': '1', 'barcode': 'barcode'}

ret_val = dolibarr_inst.call_create_api('products', params)
print(ret_val)

# get product list
product_dict = dolibarr_inst.call_list_api('products')
print(product_dict)
</syntaxHighlight>

=Develop your own service / API=
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You can take an example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, this file may be generated for you.

The framework detects automatically the API files and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

To find all existing API files in Dolibarr, you can search all files htdocs/<directory>/class/api_xxx_class.php

JA Developer documentation

2023-07-22T13:30:10Z

Cin TAKE: /* 大量エクスポート/インポート (Mass exports/imports) */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).

グラフィカルユーザーインターフェイス（GUI）への変更作成は、本章には含まれない。これについては、前章を参照.

cronスクリプトや外部ソースからデータを取り込むためのコマンドラインインポートツールなど、スクリプトを開発するには、スクリプト開発 ([[Script development]]) ページをご覧ください.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
Dolibarr 設定パラメータは3か所存在する.

*Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ: <code>/conf/conf.php</code> .

:さらに詳細は [[Configuration file]] を参照.

*グローバル特質パラメータは [[Table llx_const]] に保存.

:さらに詳細は [[Constants]] ページを参照.

*ユーザに対する特質パラメータは [[Table llx_user_param]] に保存.

==ビジネスオブジェクト (Business objects)==
参照 [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
参照 [[Menus system]]

==タブシステム (Tabs system)==
参照 [[Tabs system]]

==スキンシステム (Skins system)==
参照 [[Skins]]

==ウィジェットシステム (Widget system)==
参照 [[Widget system]]

==認証システム (Authentication system)==
参照 [[Authentication]]

==許可システム (Permission system)==
参照 [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
参照 [[Translation system]]

==エラー管理 (Error management)==
参照 [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvasは、レコード（商品、取引先、連絡先など）を作成、更新、閲覧するための画面を置き換える開発者向けの機能. 例えば、取引先の新規作成に使用する入力フォームやその編集フォームを置き換えたり、閲覧テンプレートを置き換えたりすることがでる.

参照 [[Canvas development]]

==トリガーシステム (Triggers system)==
トリガーは、Dolibarrの "ビジネスイベント" （請求書の作成、ユーザーの削除、取引先の更新など）に付随して、パーソナライズされたコードを実行するための開発機能で、ビジネスイベントに対してのみ有効. 他のコンテキストでコードをパーソナライズするには、代わりにフックシステム ('''Hooks system) の章を参照'''.

トリガーの使用に関して、参照 [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
参照 [[Hooks system]]

==変数置換システム (Variable substitution system)==
参照 [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr はいくつかのサービスを提供するように設定可能.

参照 [[Module Web Services API REST (developer)]]

注: [[Module Web Services API SOAP (developer)]] は非推奨.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
参照 [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For アプリケーションで作成された各エンティティに対して、Dolibarrは参照を割り当てる．どのような用途にも参照を適応できるように、Dolibarrはモジュールを使って参照生成ルールを定義する．いくつかの標準モジュールが提供されてる．あるモジュールは汎用的で、ナンバリングマスクの定義に使用される(x文字の番号、接頭辞の有無、日付の有無、など)。しかし、提供されているモジュールがニーズを満たさない場合もある．この場合、カスタム番号モジュールを開発する必要がある．

詳しくは, [[Create numeration module|Create numbering module]] を参照.
==文書テンプレートと文書生成 (Document templates and documents generation)==

テンプレートからの文書生成に関して、 [[Create a PDF document template]] や [[Create an ODT document template]] に更なる説明がある.

==エクストラフィールド (Extrafields)==
参照 [[Extrafields]]

==オンライン決済システム (Online payment system)==
参照 [[Online payment system]]

==他内部機能 (Other internal function)==
自前コードで利用できる多くの内部ライブラリがある．functions.lib.php、functions2.lib.php、admin.lib.phpに多くの汎用関数が見つかる． htdocs/core/lib/*.lib ファイルにある関数はどれでも使用可．

'''Dolibarrのバージョン番号に基づく要件を指定するには'''

例えば、Dolibarrバージョンの3.5以上を前提条件にするには、 admin.lib.php にある versioncompare と versiondolibarrarray を使用する：

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

*[[Mass imports]]
*[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

*[https://wiki.dolibarr.org/Interfaces_Dolibarr_toward_foreign_systems Interfaces Dolibarr toward foreign systems] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
*[https://wiki.dolibarr.org/Interfaces_from_foreign_systems_toward_Dolibarr Interfaces from foreign systems toward Dolibarr]

Integrate Dolibarr to automation platforms:

*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_Zapier_automation_platform Integration of Dolibarr to the Zapier automation platform]
*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_n8n_automation_platform Integration of Dolibarr to the n8n automation platform]
*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_Make_automation_platform Integration of Dolibarr to the Make automation platform]

=FAQ=
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能
[[Category:Development]]

JA Developer documentation

2023-07-22T13:25:57Z

Cin TAKE: /* 他のアプリとのインタフェースやリンク (Interfaces and links with other applications) */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).

グラフィカルユーザーインターフェイス（GUI）への変更作成は、本章には含まれない。これについては、前章を参照.

cronスクリプトや外部ソースからデータを取り込むためのコマンドラインインポートツールなど、スクリプトを開発するには、スクリプト開発 ([[Script development]]) ページをご覧ください.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
Dolibarr 設定パラメータは3か所存在する.

*Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ: <code>/conf/conf.php</code> .

:さらに詳細は [[Configuration file]] を参照.

*グローバル特質パラメータは [[Table llx_const]] に保存.

:さらに詳細は [[Constants]] ページを参照.

*ユーザに対する特質パラメータは [[Table llx_user_param]] に保存.

==ビジネスオブジェクト (Business objects)==
参照 [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
参照 [[Menus system]]

==タブシステム (Tabs system)==
参照 [[Tabs system]]

==スキンシステム (Skins system)==
参照 [[Skins]]

==ウィジェットシステム (Widget system)==
参照 [[Widget system]]

==認証システム (Authentication system)==
参照 [[Authentication]]

==許可システム (Permission system)==
参照 [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
参照 [[Translation system]]

==エラー管理 (Error management)==
参照 [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvasは、レコード（商品、取引先、連絡先など）を作成、更新、閲覧するための画面を置き換える開発者向けの機能. 例えば、取引先の新規作成に使用する入力フォームやその編集フォームを置き換えたり、閲覧テンプレートを置き換えたりすることがでる.

参照 [[Canvas development]]

==トリガーシステム (Triggers system)==
トリガーは、Dolibarrの "ビジネスイベント" （請求書の作成、ユーザーの削除、取引先の更新など）に付随して、パーソナライズされたコードを実行するための開発機能で、ビジネスイベントに対してのみ有効. 他のコンテキストでコードをパーソナライズするには、代わりにフックシステム ('''Hooks system) の章を参照'''.

トリガーの使用に関して、参照 [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
参照 [[Hooks system]]

==変数置換システム (Variable substitution system)==
参照 [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr はいくつかのサービスを提供するように設定可能.

参照 [[Module Web Services API REST (developer)]]

注: [[Module Web Services API SOAP (developer)]] は非推奨.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
参照 [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For アプリケーションで作成された各エンティティに対して、Dolibarrは参照を割り当てる．どのような用途にも参照を適応できるように、Dolibarrはモジュールを使って参照生成ルールを定義する．いくつかの標準モジュールが提供されてる．あるモジュールは汎用的で、ナンバリングマスクの定義に使用される(x文字の番号、接頭辞の有無、日付の有無、など)。しかし、提供されているモジュールがニーズを満たさない場合もある．この場合、カスタム番号モジュールを開発する必要がある．

詳しくは, [[Create numeration module|Create numbering module]] を参照.
==文書テンプレートと文書生成 (Document templates and documents generation)==

テンプレートからの文書生成に関して、 [[Create a PDF document template]] や [[Create an ODT document template]] に更なる説明がある.

==エクストラフィールド (Extrafields)==
参照 [[Extrafields]]

==オンライン決済システム (Online payment system)==
参照 [[Online payment system]]

==他内部機能 (Other internal function)==
自前コードで利用できる多くの内部ライブラリがある．functions.lib.php、functions2.lib.php、admin.lib.phpに多くの汎用関数が見つかる． htdocs/core/lib/*.lib ファイルにある関数はどれでも使用可．

'''Dolibarrのバージョン番号に基づく要件を指定するには'''

例えば、Dolibarrバージョンの3.5以上を前提条件にするには、 admin.lib.php にある versioncompare と versiondolibarrarray を使用する：

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

*[https://wiki.dolibarr.org/Interfaces_Dolibarr_toward_foreign_systems Interfaces Dolibarr toward foreign systems] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
*[https://wiki.dolibarr.org/Interfaces_from_foreign_systems_toward_Dolibarr Interfaces from foreign systems toward Dolibarr]

Integrate Dolibarr to automation platforms:

*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_Zapier_automation_platform Integration of Dolibarr to the Zapier automation platform]
*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_n8n_automation_platform Integration of Dolibarr to the n8n automation platform]
*[https://wiki.dolibarr.org/Integration_of_Dolibarr_to_the_Make_automation_platform Integration of Dolibarr to the Make automation platform]

=FAQ=
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能
[[Category:Development]]

JA Developer documentation

2023-06-24T07:18:56Z

Cin TAKE: /* 番号付けモジュール (Numbering modules) */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).

グラフィカルユーザーインターフェイス（GUI）への変更作成は、本章には含まれない。これについては、前章を参照.

cronスクリプトや外部ソースからデータを取り込むためのコマンドラインインポートツールなど、スクリプトを開発するには、スクリプト開発 ([[Script development]]) ページをご覧ください.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
Dolibarr 設定パラメータは3か所存在する.

*Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ: <code>/conf/conf.php</code> .

:さらに詳細は [[Configuration file]] を参照.

*グローバル特質パラメータは [[Table llx_const]] に保存.

:さらに詳細は [[Constants]] ページを参照.

*ユーザに対する特質パラメータは [[Table llx_user_param]] に保存.

==ビジネスオブジェクト (Business objects)==
参照 [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
参照 [[Menus system]]

==タブシステム (Tabs system)==
参照 [[Tabs system]]

==スキンシステム (Skins system)==
参照 [[Skins]]

==ウィジェットシステム (Widget system)==
参照 [[Widget system]]

==認証システム (Authentication system)==
参照 [[Authentication]]

==許可システム (Permission system)==
参照 [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
参照 [[Translation system]]

==エラー管理 (Error management)==
参照 [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvasは、レコード（商品、取引先、連絡先など）を作成、更新、閲覧するための画面を置き換える開発者向けの機能. 例えば、取引先の新規作成に使用する入力フォームやその編集フォームを置き換えたり、閲覧テンプレートを置き換えたりすることがでる.

参照 [[Canvas development]]

==トリガーシステム (Triggers system)==
トリガーは、Dolibarrの "ビジネスイベント" （請求書の作成、ユーザーの削除、取引先の更新など）に付随して、パーソナライズされたコードを実行するための開発機能で、ビジネスイベントに対してのみ有効. 他のコンテキストでコードをパーソナライズするには、代わりにフックシステム ('''Hooks system) の章を参照'''.

トリガーの使用に関して、参照 [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
参照 [[Hooks system]]

==変数置換システム (Variable substitution system)==
参照 [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr はいくつかのサービスを提供するように設定可能.

参照 [[Module Web Services API REST (developer)]]

注: [[Module Web Services API SOAP (developer)]] は非推奨.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
参照 [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For アプリケーションで作成された各エンティティに対して、Dolibarrは参照を割り当てる．どのような用途にも参照を適応できるように、Dolibarrはモジュールを使って参照生成ルールを定義する．いくつかの標準モジュールが提供されてる．あるモジュールは汎用的で、ナンバリングマスクの定義に使用される(x文字の番号、接頭辞の有無、日付の有無、など)。しかし、提供されているモジュールがニーズを満たさない場合もある．この場合、カスタム番号モジュールを開発する必要がある．

詳しくは, [[Create numeration module|Create numbering module]] を参照.
==文書テンプレートと文書生成 (Document templates and documents generation)==

テンプレートからの文書生成に関して、 [[Create a PDF document template]] や [[Create an ODT document template]] に更なる説明がある.

==エクストラフィールド (Extrafields)==
参照 [[Extrafields]]

==オンライン決済システム (Online payment system)==
参照 [[Online payment system]]

==他内部機能 (Other internal function)==
自前コードで利用できる多くの内部ライブラリがある．functions.lib.php、functions2.lib.php、admin.lib.phpに多くの汎用関数が見つかる． htdocs/core/lib/*.lib ファイルにある関数はどれでも使用可．

'''Dolibarrのバージョン番号に基づく要件を指定するには'''

例えば、Dolibarrバージョンの3.5以上を前提条件にするには、 admin.lib.php にある versioncompare と versiondolibarrarray を使用する：

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能
[[Category:Development]]

モジュール開発

2023-06-24T06:55:04Z

Cin TAKE: /* タブ管理 (任意) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分からなる．

*Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
{{TemplateModuleTabsJA}}

*Part 2: タブのコードで、タブの追加（+で始まる）または削除（-で始まる）を識別する．
*Part 3: タブのタイトル．タイトルが読みずらいなら、コードにして言語ファイルで翻訳するとよい．
*Part 4: ファイル名 "*.lang" は、コード翻訳と表示する言語の対応を含む．この名前の後に@mymoduleが続く場合、 Dolibarrはモジュール内の翻訳ファイル "*.lang "を検索するので、htdocs/mymodule/langs/code_CODE/mylangfile.langとなり、そうでない場合はhtdocs/langs/code_CODE/mylangfile.langとなる．
*Part 5: タブを常時表示すべきかのテスト条件．常時表示の場合は1を指定．
*Part 6: タブをクリックしたときに表示されるページのURL。__ID__の文字列は自動的に当該要素のIdに置き換えられる．

タブの内容へデータベースからのデータを注入するには、次章を参照．

既存タブの名前 'tabname' を取得するには、ファイル 'core/lib/module.lib.php' の関数 'product_prepare_head' で使用されている名前で、セクション '$head[$h][2]' に対応するものをチェックする必要がある．

===自前ページにタブナビゲーションを表示===
'''使用場面''': 自前ページにオブジェクト(製品、階層、など)の標準タブを表示したい

以下の手順に従う :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.

そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-06-24T06:54:22Z

Cin TAKE: /* オブジェクトシートに自前のタブを追加・削除できる */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分で構成される．

*Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
{{TemplateModuleTabsJA}}

*Part 2: タブのコードで、タブの追加（+で始まる）または削除（-で始まる）を識別する．
*Part 3: タブのタイトル．タイトルが読みずらいなら、コードにして言語ファイルで翻訳するとよい．
*Part 4: ファイル名 "*.lang" は、コード翻訳と表示する言語の対応を含む．この名前の後に@mymoduleが続く場合、 Dolibarrはモジュール内の翻訳ファイル "*.lang "を検索するので、htdocs/mymodule/langs/code_CODE/mylangfile.langとなり、そうでない場合はhtdocs/langs/code_CODE/mylangfile.langとなる．
*Part 5: タブを常時表示すべきかのテスト条件．常時表示の場合は1を指定．
*Part 6: タブをクリックしたときに表示されるページのURL。__ID__の文字列は自動的に当該要素のIdに置き換えられる．

タブの内容へデータベースからのデータを注入するには、次章を参照．

既存タブの名前 'tabname' を取得するには、ファイル 'core/lib/module.lib.php' の関数 'product_prepare_head' で使用されている名前で、セクション '$head[$h][2]' に対応するものをチェックする必要がある．

===自前ページにタブナビゲーションを表示===
'''使用場面''': 自前ページにオブジェクト(製品、階層、など)の標準タブを表示したい

以下の手順に従う :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.

そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-17T06:06:25Z

Cin TAKE: /* PHP 画面の作成や更新 (任意) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabsJA}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.

そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-17T03:39:18Z

Cin TAKE: /* PHP 画面の作成や更新 (任意) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabsJA}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成===
次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-17T03:31:30Z

Cin TAKE: /* オブジェクトシートに自前のタブを追加・削除できる */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabsJA}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Template:TemplateModuleTabsJA

2023-05-17T03:30:24Z

Cin TAKE: 初期翻訳： Enから複製

** 'thirdparty' 取引先ビューでタブ追加
** 'intervention' 出張ビューでタブ追加
** 'supplier_order' 仕入注文ビューでタブ追加
** 'supplier_invoice' 仕入請求ビューでタブ追加
** 'invoice' 顧客請求ビューでタブ追加
** 'order' 顧客注文ビューでタブ追加
** 'product' 製品ビューでタブ追加
** 'stock' 在庫ビューでタブ追加
** 'propal' 提案ビューでタブ追加
** 'member' 財団メンバービューでタブ追加
** 'contract' 契約ビューでタブ追加
** 'user' ユーザビューでタブ追加
** 'group' グループビューでタブ追加
** 'contact' 連絡先ビューでタブ追加
** 'payment' 支払ビューでタブ追加 (since 3.6.0)
** 'payment_supplier' 仕入支払ビューでタブ追加 (since 3.6.0)
** 'categories_x' 種別ビューでタブ追加 ('x' を種別タイプ (0=product, 1=supplier, 2=customer, 3=member) に変更)

モジュール開発

2023-05-17T03:12:14Z

Cin TAKE: /* Add or remove your own tabs on object sheets */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===オブジェクトシートに自前のタブを追加・削除できる===
'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合

そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-15T10:18:52Z

Cin TAKE: /* Test your .sql files */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===自前の .sql ファイルをテストする===

ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.

===PHP DAO クラスを生成===
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.

だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''

このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-10T04:39:23Z

Cin TAKE: /* 自前の .sql ファイルを作成 */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

例としてファイル data.sql の中身は
<syntaxhighlight 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__');
</syntaxhighlight>

ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Template:TemplateModuleTreeSimpleJA

2023-05-10T04:31:37Z

Cin TAKE:

* '''mymodule/*''' には php ページを配置（任意のサブディレクトリ追加も可であることに注意）注: 自前モジュールがメタパッケージ（同一 zip 内に他モジュールを埋め込むモジュールである場合、ここに metapackage.conf ファイルを置く必要がある）
* '''mymodule/build/''' には任意のファイルを配置でき、それはコンパイルやビルドに使用するもの
* '''mymodule/core/modules/''' には、モジュール記述ファイル ''' modMyModule.class.php''' を配置
* '''mymodule/core/triggers''' には、モジュールが提供するトリガーを配置
* '''mymodule/admin/''' には、モジュールを設定するページを配置
* '''mymodule/class/''' には、モジュールが提供するPHP クラスファイルを配置
* '''mymodule/css''' には、モジュールが提供する CSS ファイルを配置
* '''mymodule/js''' には、モジュールが提供する javascirpt ファイルを配置し、新規 function を追加
* '''mymodule/docs''' には、文書及びライセンスファイルを配置
* '''mymodule/img''' には、モジュールが提供する画像ファイルを配置
* '''mymodule/langs/xx_XX''' には、言語 xx_XX (少なくと en_US は配置)に対応する言語ファイルを配置
* '''mymodule/lib''' には、モジュールが提供し使用するライブラリを配置
* '''mymodule/scripts''' には、コマンドラインツールやスクリプトを配置. 注: コマンドラインスクリプトの先頭行に次のもの使う #!/usr/bin/env php
* '''mymodule/sql''' には、モジュールが提供する SQL ファイルを配置し、新規テーブルやインデックスを追加
* '''mymodule/theme/mytheme''' モジュールが自前のテーマ/スキンを提供する場合

Template:TemplateModuleTreeSimple

2023-05-08T13:13:02Z

Cin TAKE: add javascript location

* '''mymodule/*''' contains php pages (note that you can also add any other subdir of your choice). Note: If your module is a metapackage (a module that will embed other modules in same zip, you must put here a file metapackage.conf)
* '''mymodule/build/''' can contains any file you develop for compiling or building package
* '''mymodule/core/modules/''' contains module descriptor file ''' modMyModule.class.php'''
* '''mymodule/core/triggers''' contains triggers provided by module
* '''mymodule/admin/''' contains pages to setup module
* '''mymodule/class/''' contains PHP class files provided by module
* '''mymodule/css''' contains CSS files provided by module
* '''mymodule/js''' contains javascirpt files provided by module to add new functions
* '''mymodule/docs''' to provide doc and licence files
* '''mymodule/img''' contains images files provided by module
* '''mymodule/langs/xx_XX''' contains language files for language xx_XX (try to put at least en_US)
* '''mymodule/lib''' contains libraries provided and used by module
* '''mymodule/scripts''' to provide command line tools or scripts. Note: Command lines script must start with line #!/usr/bin/env php
* '''mymodule/sql''' contains SQL file provided by module to add new tables or indexes
* '''mymodule/theme/mytheme''' if module provide its own theme/skin

Template:TemplateModuleTreeSimpleJA

2023-05-08T13:12:16Z

Cin TAKE:

* '''mymodule/*''' にはphpページが含まれる（任意のサブディレクトリ追加も可であることに注意）注: 自前モジュールがメタパッケージ（同一 zip 内に他モジュールを埋め込むモジュールである場合、ここに metapackage.conf ファイルを置く必要がある）
* '''mymodule/build/''' can contains any file you develop for compiling or building package
* '''mymodule/core/modules/''' contains module descriptor file ''' modMyModule.class.php'''
* '''mymodule/core/triggers''' contains triggers provided by module
* '''mymodule/admin/''' contains pages to setup module
* '''mymodule/class/''' contains PHP class files provided by module
* '''mymodule/css''' contains CSS files provided by module
* '''mymodule/js''' contains javascirpt files provided by module to add new functions
* '''mymodule/docs''' to provide doc and licence files
* '''mymodule/img''' contains images files provided by module
* '''mymodule/langs/xx_XX''' contains language files for language xx_XX (try to put at least en_US)
* '''mymodule/lib''' contains libraries provided and used by module
* '''mymodule/scripts''' to provide command line tools or scripts. Note: Command lines script must start with line #!/usr/bin/env php
* '''mymodule/sql''' contains SQL file provided by module to add new tables or indexes
* '''mymodule/theme/mytheme''' if module provide its own theme/skin

モジュール開発

2023-05-08T10:37:27Z

Cin TAKE: /* 新規モジュールファイルに関するパスツリー (必須) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimpleJA}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

Template:TemplateModuleTreeSimpleJA

2023-05-08T10:36:49Z

Cin TAKE: 複製して初期翻訳

* '''mymodule/*''' にはphpページが含まれる（任意のサブディレクトリ追加も可であることに注意）注: 自前モジュールがメタパッケージ（同一 zip 内に他モジュールを埋め込むモジュールである場合、ここに metapackage.conf ファイルを置く必要がある）
* '''mymodule/build/''' can contains any file you develop for compiling or building package
* '''mymodule/core/modules/''' contains module descriptor file ''' modMyModule.class.php'''
* '''mymodule/core/triggers''' contains triggers provided by module
* '''mymodule/admin/''' contains pages to setup module
* '''mymodule/class/''' contains PHP class files provided by module
* '''mymodule/css''' contains CSS files provided by module
* '''mymodule/docs''' to provide doc and licence files
* '''mymodule/img''' contains images files provided by module
* '''mymodule/langs/xx_XX''' contains language files for language xx_XX (try to put at least en_US)
* '''mymodule/lib''' contains libraries provided and used by module
* '''mymodule/scripts''' to provide command line tools or scripts. Note: Command lines script must start with line #!/usr/bin/env php
* '''mymodule/sql''' contains SQL file provided by module to add new tables or indexes
* '''mymodule/theme/mytheme''' if module provide its own theme/skin

モジュール開発

2023-05-08T10:18:40Z

Cin TAKE: /* 新規モジュールファイルに関するパスツリー (必須) */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール記述(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''

===自前のモジュール記述 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前記述をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimple}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合

===自前の .sql ファイルを作成===
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.

自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクトタブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.

次に、記述ファイルでの、'''init''' 関数にて、次の行

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

が、コメントでないことを確認する.

''従うべきルール:''

*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
*SQLフィールドの推奨される型と名前は、このページに定義されてる [[Language_and_development_rules#Table_and_fields_structures]].
*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'）ダブルクォートは PostGreSQL では特定の意味を持つ

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-03T13:36:58Z

Cin TAKE: /* 自前のモジュール説明 (module descriptor) を作成する */ 訳者注を追加

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール説明(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール説明を生成するための標準モデルとして使える'''

===自前のモジュール説明 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル説明 (file descriptor) を作成すること. (訳者注：以下の内容は'''モジュールビルダを使うことで自動設定'''される)

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前説明をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール説明でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimple}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

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

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-05-03T12:58:57Z

Cin TAKE: /* 自前のモジュール説明 (module descriptor) を作成する */

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール説明(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール説明を生成するための標準モデルとして使える'''

===自前のモジュール説明 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル説明 (file descriptor) を作成すること.

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' ここはDolibarr の公式コアモジュール (official core module) とする場合. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変更. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変更:

*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "modNewName" で置換).
*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[List of modules id|List of modules id]].
*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.

自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.

===自前説明をテストする===

Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
モジュール説明でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にしてから "development" モジュールを見るかする必要がある.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimple}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

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

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

JA Developer documentation

2023-05-03T12:31:19Z

Cin TAKE: /* バッチまたはコマンドラインスクリプトを作るには */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).

グラフィカルユーザーインターフェイス（GUI）への変更作成は、本章には含まれない。これについては、前章を参照.

cronスクリプトや外部ソースからデータを取り込むためのコマンドラインインポートツールなど、スクリプトを開発するには、スクリプト開発 ([[Script development]]) ページをご覧ください.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
Dolibarr 設定パラメータは3か所存在する.

*Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ: <code>/conf/conf.php</code> .

:さらに詳細は [[Configuration file]] を参照.

*グローバル特質パラメータは [[Table llx_const]] に保存.

:さらに詳細は [[Constants]] ページを参照.

*ユーザに対する特質パラメータは [[Table llx_user_param]] に保存.

==ビジネスオブジェクト (Business objects)==
参照 [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
参照 [[Menus system]]

==タブシステム (Tabs system)==
参照 [[Tabs system]]

==スキンシステム (Skins system)==
参照 [[Skins]]

==ウィジェットシステム (Widget system)==
参照 [[Widget system]]

==認証システム (Authentication system)==
参照 [[Authentication]]

==許可システム (Permission system)==
参照 [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
参照 [[Translation system]]

==エラー管理 (Error management)==
参照 [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvasは、レコード（商品、取引先、連絡先など）を作成、更新、閲覧するための画面を置き換える開発者向けの機能. 例えば、取引先の新規作成に使用する入力フォームやその編集フォームを置き換えたり、閲覧テンプレートを置き換えたりすることがでる.

参照 [[Canvas development]]

==トリガーシステム (Triggers system)==
トリガーは、Dolibarrの "ビジネスイベント" （請求書の作成、ユーザーの削除、取引先の更新など）に付随して、パーソナライズされたコードを実行するための開発機能で、ビジネスイベントに対してのみ有効. 他のコンテキストでコードをパーソナライズするには、代わりにフックシステム ('''Hooks system) の章を参照'''.

トリガーの使用に関して、参照 [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
参照 [[Hooks system]]

==変数置換システム (Variable substitution system)==
参照 [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr はいくつかのサービスを提供するように設定可能.

参照 [[Module Web Services API REST (developer)]]

注: [[Module Web Services API SOAP (developer)]] は非推奨.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
参照 [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
参照 [[Extrafields]]

==オンライン決済システム (Online payment system)==
参照 [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能
[[Category:Development]]

JA Developer documentation

2023-04-28T11:47:09Z

Cin TAKE: /* モジュールリスト */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
Dolibarr 設定パラメータは3か所存在する.

*Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ: <code>/conf/conf.php</code> .

:さらに詳細は [[Configuration file]] を参照.

*グローバル特質パラメータは [[Table llx_const]] に保存.

:さらに詳細は [[Constants]] ページを参照.

*ユーザに対する特質パラメータは [[Table llx_user_param]] に保存.

==ビジネスオブジェクト (Business objects)==
参照 [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
参照 [[Menus system]]

==タブシステム (Tabs system)==
参照 [[Tabs system]]

==スキンシステム (Skins system)==
参照 [[Skins]]

==ウィジェットシステム (Widget system)==
参照 [[Widget system]]

==認証システム (Authentication system)==
参照 [[Authentication]]

==許可システム (Permission system)==
参照 [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
参照 [[Translation system]]

==エラー管理 (Error management)==
参照 [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
参照 [[Hooks system]]

==変数置換システム (Variable substitution system)==
参照 [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr はいくつかのサービスを提供するように設定可能.

参照 [[Module Web Services API REST (developer)]]

注: [[Module Web Services API SOAP (developer)]] は非推奨.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
参照 [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
参照 [[Extrafields]]

==オンライン決済システム (Online payment system)==
参照 [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能
[[Category:Development]]

モジュール開発

2023-04-28T11:17:43Z

Cin TAKE:

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール説明(Module descriptor)を作る (必須)==
'''必須となる時期''': アドオンを開発すると早急に必要、たとえゴールが何であれ (例外はスキンの追加).

'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール説明を生成するための標準モデルとして使える'''

===自前のモジュール説明 (module descriptor) を作成する===
最初のステップは、モジュールに対するファイル説明 (file descriptor) を作成すること.

*ディレクトリ作成： '''/htdocs/custom/''mymodule''/core/modules''' (外部モジュール向け) または '''/htdocs/''mymodule''/core/modules''' 、 Dolibarr の公式コアモジュール (official core module) とする場合は. 次にファイル modMyModule.class.php をディレクトリ '''htdocs/modulebuilder/template''' からコピーして上記のディレクトリに作成する. ファイルの名称を modMyModule.class.php から自前モジュールの目的に合致した名称に変える. ファイル名は、先頭に 'mod' があり、最後が .class.php で終わる (例えば、ファイル名を '新名' にするなら, 'mod新名.class.php' となる).

次は、ファイルの内容を以下のように変える:

*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===自前の説明をテストする===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==新規モジュールファイルに関するパスツリー (必須)==
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
注：2行目だけが必須.

{{TemplateModuleTreeSimple}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

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

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-04-27T10:35:01Z

Cin TAKE: 見出し翻訳

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*データベースに新規テーブルを追加.
*自前メニュー項目を追加.
*新規テーブル編集用の新規画面を追加.
*オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
*内部エキスポートツール向けの事前定義済のエクスポートを追加.
*ホームページに新規情報ウィジェットを追加.
*新規置換変数を追加.
*新規許認可を定義.
*特定の Dolibarr アクションにより自動トリガされるコードを実行.
*Dolibarr フックポジション内に自分のコードを挿入.
*オブジェクト参照を生成するための自前の番号付けルールを追加
*新規文書テンプレートを追加.
*新規スキンを追加.

etc...

以下の章では、これらすべてを手作業で簡単に行う方法を示す.

=モジュールビルダによるモジュールの生成=
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:

*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,

[[File:Mod_builder_2.png|400px]]

*その後 "バグ(bug)" 画像をクリック、場所は画面右上.

[[File:Mod_builder_3.png|400px]]

=テンプレート外部モジュールの例=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=自前モジュールを作る=
==自前モジュールに関するモジュール説明(Module descriptor)を作る (必須)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').

Next modify the contents of this file as follows:

*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==新規モジュールファイルに関するパスツリー (必須)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==自前 SQL テーブルと PHP DAO クラス (任意)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

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

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==タブ管理 (任意)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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 画面の作成や更新 (任意)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==自前の準備ページを追加 (任意)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==メニューに自前項目を定義 (任意)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the 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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

==自前のエキスポートを定義 (任意)==
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).

===Define export===
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 a 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.

==自前の CSS スタイルを定義 (任意)==
'''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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==自前の Javascript 関数を追加 (任意)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==いずれかの 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]]

==Dolibarr フックポジションの内部に、自前コードを挿入 (任意)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the 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 are not covered by existing rules.

See page [[Create numbering module]].

==自前の文書テンプレートを追加 (任意)==
'''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]].

==自前のスキンを追加 (任意)==
'''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]].

=コーディングルールおよび定義済み関数=
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 marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=DoliStore での外部モジュール有効化/活性化条件=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

モジュール開発

2023-04-27T07:50:48Z

Cin TAKE: 初期翻訳： Enから複製

[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[de:Modul_Entwicklung]]
[[zh:模块开发]]


[[Category:Core]]
{{TemplateDocDevEn}}

Dolibarr向け新規モジュール/アドオンを作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :

*Add new tables in database.
*Add your own menu entries.
*Add new screens to edit new tables.
*Add or remove tabs on object view (invoice, product, order, event, ...).
*Add predefined exports for the internal export tool.
*Add new information widget in the home page.
*Add new substitutions variables.
*Define new permissions.
*Execute code automatically triggered by a particular Dolibarr action.
*Insert your code inside Dolibarr hooks positions.
*Add your numbering rule to generate the reference of objects
*Add a new document template.
*Add a new skin.

etc...

Following chapters presents how to do all of this manually with an easy way.

=Module creation with the module builder=
From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

*Go into the list of module and enable the module "Module Builder",

[[File:Mod_builder_2.png|400px]]

*Then click on the "bug" image in the top right of screen.

[[File:Mod_builder_3.png|400px]]

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=Create your module=
==Create a Module descriptor for your Module (required)==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).

'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

===Create your module descriptor===
The first step is to create a file descriptor for the module.

*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').

Next modify the contents of this file as follows:

*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Your file descriptor for your module is ready. See the next step to activate it.

===Test your descriptor===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

==Tree of path for new module files (required)==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only the second line is mandatory.

{{TemplateModuleTreeSimple}}

==Create your SQL tables and the PHP DAO class (optional)==
'''When''': If your module needs to manage data of its own

===Create your .sql file===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).

Then check into your descriptor file, into function '''init''' that the line

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

is not commented.

''Rules to follow:''

*Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL

Example of content of a file data.sql
<syntaxhighlight 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__');
</syntaxhighlight>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

===Test your .sql files===

Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

===Generate the PHP DAO class===
The DAO PHP files should have been generated by ModuleBuilder after creating an object.

You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''

In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.

==The tab management (optional)==

===Add or remove your own tabs on object sheets===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<syntaxhighlight 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
</syntaxhighlight>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"

*Part 1: The element type (object type) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}

*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
*Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
*Part 6: The URL of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.

===Show tabs navigation into your own pages===
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :

*Object thirdparty (thirdparty) :
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php
*Object product (product) :
**DOL_DOCUMENT_ROOT/product/class/product.class.php
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php
*Object invoice (invoice) :
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php

...

'''2. Create and load the object to show into your tab'''

Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).

''Example :''
<syntaxhighlight 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
</syntaxhighlight>

'''3. Get a list of all tabs to show for your object type'''

Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.

The resulting array has the following structure
<syntaxhighlight 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
</syntaxhighlight>

''Example :''
<syntaxhighlight lang="PHP">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</syntaxhighlight>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<syntaxhighlight 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
</syntaxhighlight>

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.

==Create or modify PHP screens (optional)==
'''When''': If the purpose of your module is to add features that require new or modified screens.

===Create a new PHP screen===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''myobject_page.phpp''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<syntaxhighlight 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 calculated 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");
</syntaxhighlight>
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.

Note that you may add more "../" depending on the depth of the file relative to your module directory tree.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

*$user Object that contains the characteristics of the user + his permissions.
*$conf Object that contains Dolibarr configuration.
*$db Object that contains an opened connection handler to the database.
*$langs Object that contains the user's language.

Then enter your code to display the page.

*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):

''Example :''
<syntaxhighlight lang="PHP">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</syntaxhighlight>

*To include classes provided with Dolibarr, use the following syntax:

''Example :''
<syntaxhighlight lang="PHP">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</syntaxhighlight>

===Add some fields into existing forms===
You may want to provide a module that adds more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

===Add/replace part of fields supported by hooks===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

===Database access===
If you need to edit some data in the database inside your own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

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

To read:

<syntaxhighlight 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++;
}
}
}
</syntaxhighlight>

===Define style of your pages===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

*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"''.

===Use the Dolibarr date picker===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<syntaxhighlight lang="PHP">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</syntaxhighlight>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<syntaxhighlight lang="PHP">
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
</syntaxhighlight>

===Overwrite template file (tpl)===
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
<syntaxhighlight lang="PHP">
'tpl' => 1,
</syntaxhighlight>
Then you can put any tpl file on '''mymodule/core/tpl'''
as soon as the module is activate, the tpl will be overwrited

==Add your own setup page (optional)==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

===Create your page to edit parameters===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

===Modify the descriptor file of your module===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php");
</syntaxhighlight>
If the page is in the directory '''mymodule/admin/''', then like this:
<syntaxhighlight lang="PHP">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</syntaxhighlight>

===Test your page===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

==Define your entries in menu (optional)==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

===Define your menu entries===
For this, you must define into the module descriptor, the array this->menu that declares 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:
<syntaxhighlight 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++;
</syntaxhighlight>

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

===Test your menu entries===
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

==Add your own permissions (optional)==
'''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
<syntaxhighlight lang="PHP">
$this->rights_class = 'mymodule'
</syntaxhighlight>
with correct value for mymodule.

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

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

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][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.
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:

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

==Define your own box (optional)==
'''When''': If your module needs to provide one or several new boxes to show on home page.

===Define your box===
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:''
<syntaxhighlight 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'
</syntaxhighlight>

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 activate. Activate the box and go on the home page to see if the box is showing correctly.

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

===Define export===
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 a 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 several CSS files 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 files only if you need absolutely to add not already existing styles.

Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be an array of relative URLs to your CSS files.
For example
<syntaxhighlight lang="PHP">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
</syntaxhighlight>

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

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

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

==Add your Javascript functions (optional)==
'''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 :
<syntaxhighlight lang="PHP">
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</syntaxhighlight>

==Run your own code on any Dolibarr event (optional)==
'''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]]

==Insert your code inside Dolibarr hooks positions (optional)==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).

See page [[Hooks_system]].

==Add your own numbering rules==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.

See page [[Create numbering module]].

==Add your document template (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]].

==Add your skin (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]].

=Some coding rules and predefined functions=
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".

=Create a package to distribute and install your module=
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.
But you can use it to have a package easy to distribute on your own 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 a 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):

<syntaxhighlight lang="bash">
perl makepack-dolibarrmodule.pl
</syntaxhighlight>
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:

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

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

=Enabling/activation condition of external module on DoliStore=

See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]

JA Developer documentation

2023-04-27T07:40:02Z

Cin TAKE: /* ツリー構造 (Tree structure) */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
現バージョンのファイルのパス階層は、 [http://doxygen.dolibarr.org/ doxygen generated documentation] ("javadoc" 文書に類似) から把握できる.

新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 ([[Module development|Module development 参照]]) で定義される.

==ストレージ準備 (Setup storage)==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==ビジネスオブジェクト (Business objects)==
See [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
See [[Menus system]]

==タブシステム (Tabs system)==
See [[Tabs system]]

==スキンシステム (Skins system)==
See [[Skins]]

==ウィジェットシステム (Widget system)==
See [[Widget system]]

==認証システム (Authentication system)==
See [[Authentication]]

==許可システム (Permission system)==
See [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
See [[Translation system]]

==エラー管理 (Error management)==
See [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
See [[Hooks system]]

==変数置換システム (Variable substitution system)==
See [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
See [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
See [[Extrafields]]

==オンライン決済システム (Online payment system)==
See [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

JA Developer documentation

2023-04-26T11:21:03Z

Cin TAKE: /* GUI 向けの新モジュール/アドオンを作るには */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[モジュール開発|モジュール開発]] チュートリアルを確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==ストレージ準備 (Setup storage)==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==ビジネスオブジェクト (Business objects)==
See [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
See [[Menus system]]

==タブシステム (Tabs system)==
See [[Tabs system]]

==スキンシステム (Skins system)==
See [[Skins]]

==ウィジェットシステム (Widget system)==
See [[Widget system]]

==認証システム (Authentication system)==
See [[Authentication]]

==許可システム (Permission system)==
See [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
See [[Translation system]]

==エラー管理 (Error management)==
See [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
See [[Hooks system]]

==変数置換システム (Variable substitution system)==
See [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
See [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
See [[Extrafields]]

==オンライン決済システム (Online payment system)==
See [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

JA Developer documentation

2023-04-26T11:19:30Z

Cin TAKE: /* GUI 向けの新モジュール/アドオンを作るには */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート、ソースコード、またはそれらのすべて.

スクリプト開発はこの項には含まれない (これは次章で述べる).

自分のモジュールを開発するには、[[Module development]] tutorial を確認すること.

=バッチまたはコマンドラインスクリプトを作るには=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==ストレージ準備 (Setup storage)==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==ビジネスオブジェクト (Business objects)==
See [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
See [[Menus system]]

==タブシステム (Tabs system)==
See [[Tabs system]]

==スキンシステム (Skins system)==
See [[Skins]]

==ウィジェットシステム (Widget system)==
See [[Widget system]]

==認証システム (Authentication system)==
See [[Authentication]]

==許可システム (Permission system)==
See [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
See [[Translation system]]

==エラー管理 (Error management)==
See [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
See [[Hooks system]]

==変数置換システム (Variable substitution system)==
See [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
See [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
See [[Extrafields]]

==オンライン決済システム (Online payment system)==
See [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

JA Developer documentation

2023-04-26T11:08:52Z

Cin TAKE: /* ビジネスオブジェクト (Business objects) */

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

=バッチまたはコマンドラインスクリプトを作るには=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==ストレージ準備 (Setup storage)==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==ビジネスオブジェクト (Business objects)==
See [[ビジネスオブジェクト|ビジネスオブジェクト]]

==メニューシステム (Menu system)==
See [[Menus system]]

==タブシステム (Tabs system)==
See [[Tabs system]]

==スキンシステム (Skins system)==
See [[Skins]]

==ウィジェットシステム (Widget system)==
See [[Widget system]]

==認証システム (Authentication system)==
See [[Authentication]]

==許可システム (Permission system)==
See [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
See [[Translation system]]

==エラー管理 (Error management)==
See [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
See [[Hooks system]]

==変数置換システム (Variable substitution system)==
See [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
See [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
See [[Extrafields]]

==オンライン決済システム (Online payment system)==
See [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

JA Developer documentation

2023-04-26T11:07:22Z

Cin TAKE: 見出し翻訳

{{DISPLAYTITLE:開発者手引き}}

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=開発組織とツール=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=コーディング規約とベストプラクティス=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=モジュールリスト=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=GUI 向けの新モジュール/アドオンを作るには=
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

=バッチまたはコマンドラインスクリプトを作るには=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Dolibarr の技術的要素 (Technical components)=
==ツリー構造 (Tree structure)==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==ストレージ準備 (Setup storage)==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==ビジネスオブジェクト (Business objects)==
See [[ビジネスオブジェクト]]

==メニューシステム (Menu system)==
See [[Menus system]]

==タブシステム (Tabs system)==
See [[Tabs system]]

==スキンシステム (Skins system)==
See [[Skins]]

==ウィジェットシステム (Widget system)==
See [[Widget system]]

==認証システム (Authentication system)==
See [[Authentication]]

==許可システム (Permission system)==
See [[Permissions En|Permissions]]

==翻訳システム (Translation system)==
See [[Translation system]]

==エラー管理 (Error management)==
See [[Error reporting|Error reporting]]

==キャンバスシステム (Canvas system)==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==トリガーシステム (Triggers system)==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==フックシステム (Hooks system)==
See [[Hooks system]]

==変数置換システム (Variable substitution system)==
See [[Variable substitution system]]

==ウェブサービス (Web services)==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==ファイル/書類ストレージ管理 (Files/Documents storage management)==
See [[Generated documents]]

==番号付けモジュール (Numbering modules)==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==文書テンプレートと文書生成 (Document templates and documents generation)==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==エクストラフィールド (Extrafields)==
See [[Extrafields]]

==オンライン決済システム (Online payment system)==
See [[Online payment system]]

==他内部機能 (Other internal function)==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=大量エクスポート/インポート (Mass exports/imports)=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

JA Developer documentation

2023-04-26T10:48:43Z

Cin TAKE: Duplicate From En page

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=Development organization and tools=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=Coding rules and best practices=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [http://doxygen.dolibarr.org/ doxygen generated documentation]

=List of modules=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]

=To develop a new module/addon for GUI=
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

=To develop a batch or command line script=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Technical components of Dolibarr=
==Tree structure==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==Setup storage==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==Business objects==
See [[Business Objects]]

==Menus system==
See [[Menus system]]

==Tabs system==
See [[Tabs system]]

==Skins system==
See [[Skins]]

==Widget system==
See [[Widget system]]

==Authentication system==
See [[Authentication]]

==Permission system==
See [[Permissions En|Permissions]]

==Translation system==
See [[Translation system]]

==Error management==
See [[Error reporting|Error reporting]]

==Canvas system==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==Triggers system==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==Hooks system==
See [[Hooks system]]

==Variable substitution system==
See [[Variable substitution system]]

==Web services==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==Files/Documents storage management==
See [[Generated documents]]

==Numbering modules==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==Document templates and documents generation==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==Extrafields==
See [[Extrafields]]

==Online payment system==
See [[Online payment system]]

==Other internal function==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxHighlight lang="php">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxHighlight>

=Mass exports/imports=

#[[Mass imports]]
#[[Module Exports En|Mass exports]]

=Interfaces and links with other applications=

#[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers or Hooks)
#[[Interfaces from foreign systems toward Dolibarr]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]

Template:InfoJa

2023-04-26T10:43:17Z

Cin TAKE: 日本語版Infoテンプレ

[[fr:Template:InfoFr]]
[[es:Template:InfoEs]]
[[pt:Template:InfoPT]]

ビジネスオブジェクト

2023-04-26T10:08:23Z

Cin TAKE: 日本語本文

{{TemplateDocDevEn}}
=ビジネスオブジェクト(Business objects)=
すべてのビジネスオブジェクトは、PHPのクラスであり、 CommonObject (定義ファイルは、 commonobject.class.php) を継承する.
それぞれのビジネスオブジェクトは 4つの CRUD メソッドを持ち、データベースとの読み書きに使用できる:

*作成(Create): create()
*読込(Read): fetch()
*更新(Update): update()
*削除(Delete): delete()

後述の具体例を参照...

=ビジネスオブジェクト間のリンク=
ビジネスオブジェトの中には、他のビジネスオブジェクトとリンクしているものもある。Dolibarr においては、テーブル [[Table llx_element_element]] を使うことで実現している. しかし他とリンクしているオブジェクトを取得するために、このテーブルを読む必要はない.

ここで使い方を示す (Dolibarr 3.1 以上):
<source lang="php">
// get invoices from an already loaded order:
$result = $order->fetchObjectLinked($order->id, 'commande', null, 'facture');
if ($result <= 0) {
// handle error
}
// important notice : the newly populated arrays are associative. Keys are llx_element_element row ids.

// now if we expect only one linked invoice:

// WRONG way to get it ($invoice_id will be NULL):
$invoice_id = $order->linkedObjectsIds['facture'][0]

// CORRECT way ($invoice_id will hold the ID):
$invoice_id = array_values($order->linkedObjectsIds['facture'])[0]

// Better (if there are more than one linked invoices) :
foreach ($order->linkedObjectsIds['facture'] as $element_element_id => $facture_id) {
// process it
}
</source>

Dolibarr 3.1 より旧版:
<source lang="php">
// This load the array linked_object with objects that link to this one
$object->load_object_linked($object->id, $object->element);
// To load array linked_object with objects that are linked by this one
$object->load_object_linked($object->id, $object->element);

// Then choose id with objects type you need
$org_order_array = $object->linked_object["commande"];

// Now use them
$thelinkedobjectid = $org_order_array[0];
// new order instance
$thelinkedobject = new Commande($object->db);
// load the object
$thelinkedobject->fetch($thelinkedobjectid);
</source>

=事例=

==取引先に対する事例==
ここで取引先の作成に関する事例を挙げる (例顧客法人):

新スクリプトや外部スクリプトを作る時、最初に他のものを作る前に:
<source lang="php">
include('/pathofdolibarrhtdocs/master.inc.php');
</source>
This will initialize Dolibarr environment objects ($conf, $db, $lang and $user).
If we want that actions (create, update) are tagged with a particular user as the create/update user, we must do after the include of master.inc.php and before calling any create or update method
<source lang="php">
$user->fetch(0,'loginuser');
</source>

これで、ビジネスコードを作成することができる.

<source lang="php">
// We declare the class we want to use
include_once('/pathofdolibarrhtdocs/societe/class/societe.class.php');

// We create an instance of object to manipulate
$mycompany = new Societe($db);

// We set properties on object
$mycompany->nom='Big Brother';
$mycompany->client=1;

// If we want that creation is tagged as done by a particular user 'loginuser',
// you must uncomment this line to load all characteristics of this user.
// If we keep the comment, Dolibarr will use null into fields that should store the create or update user.
// $user->fetch('loginuser');

// We call method to create
$id=$mycompany->create($user);

// This is to read/load an already created object
$mycompany->fetch($id);

// To update object
$mycompany->nom='Big Brother 2';
$mycompany->update($user);
</source>

==その他の事例==
他の事例を見つけるには、Dolibarr スナップショットの '''dev/samples''' ディレクトリを見るといいかも。そこには、Dolibarr オブジェクトの操作事例 (作成, 読込, 更新, 削除) があるはず .

ビジネスオブジェクト

2023-04-26T06:39:58Z

Cin TAKE: WIP

{{TemplateDocDevEn}}
=ビジネスオブジェクト(Business objects)=
すべてのビジネスオブジェクトは、PHPのクラスであり、 CommonObject (定義ファイルは、 commonobject.class.php) を継承する.
それぞれのビジネスオブジェクトは 4つの CRUD メソッドを持ち、データベースとの読込と書込に使用できる:

*作成(Create): create()
*読込(Read): fetch()
*更新(Update): update()
*書込(Delete): delete()

後述の具体例を参照...

=ビジネスオブジェクト間のリンク=
Some business objects are linked to other business objects. This is done in Dolibarr using the [[Table llx_element_element]]. But you don't have to read this table to get objects linked to another.

Here is how you can use this (Dolibarr 3.1 and higher):
<source lang="php">
// get invoices from an already loaded order:
$result = $order->fetchObjectLinked($order->id, 'commande', null, 'facture');
if ($result <= 0) {
// handle error
}
// important notice : the newly populated arrays are associative. Keys are llx_element_element row ids.

// now if we expect only one linked invoice:

// WRONG way to get it ($invoice_id will be NULL):
$invoice_id = $order->linkedObjectsIds['facture'][0]

// CORRECT way ($invoice_id will hold the ID):
$invoice_id = array_values($order->linkedObjectsIds['facture'])[0]

// Better (if there are more than one linked invoices) :
foreach ($order->linkedObjectsIds['facture'] as $element_element_id => $facture_id) {
// process it
}
</source>

Prior to Dolibarr < 3.1:
<source lang="php">
// This load the array linked_object with objects that link to this one
$object->load_object_linked($object->id, $object->element);
// To load array linked_object with objects that are linked by this one
$object->load_object_linked($object->id, $object->element);

// Then choose id with objects type you need
$org_order_array = $object->linked_object["commande"];

// Now use them
$thelinkedobjectid = $org_order_array[0];
// new order instance
$thelinkedobject = new Commande($object->db);
// load the object
$thelinkedobject->fetch($thelinkedobjectid);
</source>

=具体例=

==取引先に対する具体例==
Here is an example for the creation of a third party (eg customer company):

If we make a new script or an external script, we must add at the beginning, before making anything else:
<source lang="php">
include('/pathofdolibarrhtdocs/master.inc.php');
</source>
This will initialize Dolibarr environment objects ($conf, $db, $lang and $user).
If we want that actions (create, update) are tagged with a particular user as the create/update user, we must do after the include of master.inc.php and before calling any create or update method
<source lang="php">
$user->fetch(0,'loginuser');
</source>

Now we can make our business code.

<source lang="php">
// We declare the class we want to use
include_once('/pathofdolibarrhtdocs/societe/class/societe.class.php');

// We create an instance of object to manipulate
$mycompany = new Societe($db);

// We set properties on object
$mycompany->nom='Big Brother';
$mycompany->client=1;

// If we want that creation is tagged as done by a particular user 'loginuser',
// you must uncomment this line to load all characteristics of this user.
// If we keep the comment, Dolibarr will use null into fields that should store the create or update user.
// $user->fetch('loginuser');

// We call method to create
$id=$mycompany->create($user);

// This is to read/load an already created object
$mycompany->fetch($id);

// To update object
$mycompany->nom='Big Brother 2';
$mycompany->update($user);
</source>

==その他の具体例==
You may find other example for manipulating Dolibarr objects (Create, Read, Update, Delete) into directory '''dev/samples''' of Dolibarr snapshot.

Template:ActivationModuleJa

2020-10-08T13:33:46Z

Cin TAKE: Translated to Japanese

このモジュールを使うには、初めに管理者アカウントで入ってモジュールを有効化すること、使うメニューは "'''ホーム - 設定 - モジュール'''" 。

一覧からモジュールのタブを選択し、 "'''有効化(Activate)'''" をクリック。

これでモジュールが活性化される。

もし、アイコンがモジュールの行末に表示される場合は、それをクリックして、当該モジュール専用の設定ページにアクセスすること。

Dolibarr ERP CRM Wiki - User contributions [en]

JA First setup

First setup

ホームページ

User documentation JA

Template:TemplateDocUserJa

JA First setup

Template:TemplateDocUserJa

User documentation JA

ホームページ

Category:Page waiting for translation

モジュール 開発

モジュール 開発

Module Web Services API REST (developer) JA

Module Web Services API REST (developer) JA

Module Web Services API REST (developer) JA

JA Developer documentation

JA Developer documentation

JA Developer documentation

モジュール 開発

モジュール 開発

モジュール 開発

モジュール 開発

モジュール 開発

Template:TemplateModuleTabsJA

モジュール 開発

モジュール 開発

モジュール 開発

Template:TemplateModuleTreeSimpleJA

Template:TemplateModuleTreeSimple

Template:TemplateModuleTreeSimpleJA

モジュール 開発

Template:TemplateModuleTreeSimpleJA

モジュール 開発

モジュール 開発

モジュール 開発

JA Developer documentation

JA Developer documentation

モジュール 開発

モジュール 開発

モジュール 開発

JA Developer documentation

JA Developer documentation

JA Developer documentation

JA Developer documentation

JA Developer documentation

JA Developer documentation

Template:InfoJa

ビジネス オブジェクト

ビジネス オブジェクト

Template:ActivationModuleJa

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

モジュール開発

ビジネスオブジェクト

ビジネスオブジェクト