Difference between revisions of "JA Developer documentation"
Tag: 2017 source edit |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 153: | Line 153: | ||
=大量 エクスポート/インポート (Mass exports/imports)= | =大量 エクスポート/インポート (Mass exports/imports)= | ||
| − | + | *[[Mass imports]] | |
| − | + | *[[Module Exports En|Mass exports]] | |
=他のアプリとのインタフェースやリンク (Interfaces and links with other applications)= | =他のアプリとのインタフェースやリンク (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= | =FAQ= | ||
すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能 | すべての FAQs は FAQ インデックスページ [[:Category:FAQ EN|FAQ EN]] から利用可能 | ||
[[Category:Development]] | [[Category:Development]] | ||
Latest revision as of 13:30, 22 July 2023
This page is main index of documents relating to developer documentation. For user documentation see here.
開発組織とツール
This chapter contains global information that must be read before starting any development on Dolibarr.
- Organization of project
- To be known before starting to develop
- Environment and development tools
- Dependencies and external libraries
- Get or update sources of a development version
コーディング規約とベストプラクティス
- Prerequisites
- Language and development rules (PHP, SQL, HTML)
- List of tables
- Tree structure of files and classes are available in the doxygen generated documentation
モジュールリスト
標準ビジネスモデルの技術文書は、それぞれのモジュール開発者の文書ページ (documentation pages) にある. 関心に応じて適切なページを選ぶとよい:
GUI 向けの新 モジュール/アドオン を作るには
この項では、Dolibarr のユーザインタフェースを変更する新規モジュールの開発方法を述べる. 該当するのは、スクリーン、テーマ、データ、保有するCSSスタイルシート 、ソースコード、またはそれらのすべて.
スクリプト開発はこの項には含まれない (これは次章で述べる).
自分のモジュールを開発するには、モジュール開発 チュートリアルを確認すること.
バッチまたはコマンドラインスクリプトを作るには
この章では、Dolibarr でタスクを実行するためのコマンドラインスクリプト開発方法について説明する (read, update data...).
グラフィカルユーザーインターフェイス（GUI）への変更作成は、本章には含まれない。これについては、前章を参照.
cronスクリプトや外部ソースからデータを取り込むためのコマンドライン インポートツールなど、スクリプトを開発するには、スクリプト開発 (Script development) ページをご覧ください.
Dolibarr の技術的要素 (Technical components)
ツリー構造 (Tree structure)
現バージョンのファイルのパス階層は、 doxygen generated documentation ("javadoc" 文書に類似) から把握できる.
新規モジュールによる新規ファイルの追加で使用するパスは、新規モジュール開発の文書 (Module development 参照) で定義される.
ストレージ準備 (Setup storage)
Dolibarr 設定パラメータは3か所存在する.
- Dolibarr 技術的設定パラメータ (認証モード, データベースログインとファイル向けストレージ領域) が定義される設定ファイルは1つだけ:
/conf/conf.php.
- さらに詳細は 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)
認証システム (Authentication system)
許可システム (Permission system)
参照 Permissions
翻訳システム (Translation system)
エラー管理 (Error management)
キャンバスシステム (Canvas system)
Canvasは、レコード（商品、取引先、連絡先など）を作成、更新、閲覧するための画面を置き換える開発者向けの機能. 例えば、取引先の新規作成に使用する入力フォームやその編集フォームを置き換えたり、閲覧テンプレートを置き換えたりすることがでる.
トリガーシステム (Triggers system)
トリガーは、Dolibarrの "ビジネスイベント" （請求書の作成、ユーザーの削除、取引先の更新など） に付随して、パーソナライズされたコードを実行するための開発機能で、ビジネスイベントに対してのみ有効. 他のコンテキストでコードをパーソナライズするには、代わりにフックシステム (Hooks system) の章を参照.
トリガーの使用に関して、参照 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)
番号付けモジュール (Numbering modules)
For アプリケーションで作成された各エンティティに対して、Dolibarrは参照を割り当てる．どのような用途にも参照を適応できるように、Dolibarrはモジュールを使って参照生成ルールを定義する．いくつかの標準モジュールが提供されてる．あるモジュールは汎用的で、ナンバリングマスクの定義に使用される(x文字の番号、接頭辞の有無、日付の有無、など)。しかし、提供されているモジュールがニーズを満たさない場合もある．この場合、カスタム番号モジュールを開発する必要がある．
詳しくは, Create numbering module を参照.
文書テンプレートと文書生成 (Document templates and documents generation)
テンプレートからの文書生成に関して、 Create a PDF document template や Create an ODT document template に更なる説明がある.
エクストラフィールド (Extrafields)
参照 Extrafields
オンライン決済システム (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 を使用する：
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
大量 エクスポート/インポート (Mass exports/imports)
他のアプリとのインタフェースやリンク (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
Integrate Dolibarr to automation platforms:
- Integration of Dolibarr to the Zapier automation platform
- Integration of Dolibarr to the n8n automation platform
- Integration of Dolibarr to the Make automation platform
FAQ
すべての FAQs は FAQ インデックスページ FAQ EN から利用可能