1,977
edits
Changes
m
Adding interlang links (links to translated versions of this page in other languages) triggered by origin English page "Module_development" update.
Line 1:
Line 1:
−Following chapters presents how to do all of this manually with an easy way.+From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:+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]+The first step is to create a file descriptor for the module. +Next modify the contents of this file as follows:+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.+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.+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+is not commented.+Example of content of a file data.sql+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.+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.+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.+To do this go into the file descriptor of module previously created and edit the $this->tabs array:+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 ":"
−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]'.+You must follow these steps :+'''When''': If the purpose of your module is to add features that require new or modified screens.+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. +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:+Then enter your code to display the page.+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:+To read:+
<!-- BEGIN origin interlang links -->
+<!-- BEGIN interlang links -->
−<!-- You can edit this section but do NOT remove these comments
+<!-- Do NOT edit this section
− Links below will be automatically replicated on translated pages by PolyglotBot -->
+ Links below are automatically managed by PolyglotBot
+ You can edit links on the English source page : Module_development -->
+[[en:Module_development]]
[[fr:Développement_module]]
[[fr:Développement_module]]
[[es:Desarrollo_de_un_módulo]]
[[es:Desarrollo_de_un_módulo]]
Line 11:
Line 13:
{{TemplateDocDevEn}}
{{TemplateDocDevEn}}
−Dolibarr向け新規 モジュール/アドオン を作成するには, 複数のステップがある. このチュートリアルで説明するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :
+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.
+*特定の Dolibarr アクションにより自動トリガされるコードを実行.
−*Insert your code inside Dolibarr hooks positions.
+*Dolibarr フックポジション内に自分のコードを挿入.
−*Add your numbering rule to generate the reference of objects
+*オブジェクト参照を生成するための自前の番号付けルールを追加
−*Add a new document template.
+*新規文書テンプレートを追加.
−*Add a new skin.
+*新規スキンを追加.
etc...
etc...
−以下の章では、これらすべてを手作業で簡単に行う方法を示す.
−=Module creation with the module builder=
+=モジュールビルダ によるモジュールの生成=
−Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:
−*Go into the list of module and enable the module "Module Builder",
+*モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,
[[File:Mod_builder_2.png|400px]]
[[File:Mod_builder_2.png|400px]]
−*Then click on the "bug" image in the top right of screen.
+*その後 "バグ(bug)" 画像をクリック、場所は画面右上.
[[File:Mod_builder_3.png|400px]]
[[File:Mod_builder_3.png|400px]]
−=Example of Template External Module=
+=テンプレート外部モジュールの例=
−外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : [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)==
+==自前モジュールに関するモジュール記述(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'''
+'''Dolibarr 9.0 から, モジュールビルダ (ModuleBuilder) モジュールを使用すべきだ、モジュール記述を生成するための標準モデルとして使える'''
−===Create your module descriptor===
+===自前のモジュール記述 (module descriptor) を作成する===
−最初のステップは、モジュールに対するファイル記述 (file descriptor) を作成すること. (訳者注： 以下の内容は'''モジュールビルダを使うことで自動設定'''される)
−*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').
+*ディレクトリ作成： '''/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").
+*すべての "modMyModule" をモジュールの目的に合致した値に置換. この値は必ず 'mod' で始まりアルファベットのみで構成 (繰り返すが, もしファイルに付けた名称が 'NewName' なら, すべての "modMyModule" を "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]].
+*番号を変更: $this->numero = 100000 の部分で、自前モジュールIDを指定する値に. 他のモジュールとの競合を避けるため、すでに予約されているid番号の一覧ページを参考にできる: [[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).
+*コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.
−自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.
−===Test your descriptor===
+===自前記述をテストする===
−Dolibarrを起動し、'''設定->モジュール (Setup->module'''?) ページを表示.
−モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず '''設定->その他 (Setup-Others)''' に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にして から "development" モジュールを見るかする必要がある.
−==Tree of path for new module files (required)==
+==新規モジュールファイルに関するパスツリー (必須)==
−これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり).
−注：2行目だけが必須.
−{{TemplateModuleTreeSimple}}
+{{TemplateModuleTreeSimpleJA}}
−==Create your SQL tables and the PHP DAO class (optional)==
+==自前 SQL テーブル と PHP DAO クラス (任意)==
−'''When''': If your module needs to manage data of its own
+'''使用場面''': 自前モジュールがそれ自身のデータを管理する必要がある場合
−===Create your .sql file===
+===自前の .sql ファイルを作成===
−自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.
−自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("'''mymodule/sql'''") に保存される。(ModuleBuilder では、オブジェクト タブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.
−次に、記述ファイルでの、'''init''' 関数にて、次の行
<syntaxhighlight lang="php">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>
<syntaxhighlight lang="php">$this->_load_tables('/mymodule/sql/');</syntaxhighlight>
−が、コメントでないことを確認する.
−''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).
+*テーブルごとに '''llx_matable.sql''' ファイルを１つ、'''llx_matable.key.sql''' ファイルを可能なら１つ、作成するという原則に基づき、テーブル作成コマンドのファイルを追加する（例として、 '''install/mysql/tables''' にあるファイルを参照）.
−*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].
+*SQLフィールドの推奨される型と名前は、このページに定義されてる [[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.
+*データ管理のため、 '''/mymodule/sql/''' ディレクトリ内に '''data.sql''' というファイルを作成し、データの追加/編集/削除を行う SQL コマンドを記述すること.
−*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL
+*文字列にダブルクォートを使わない（例： "chaine" でなく 'chaine'） ダブルクォートは PostGreSQL では特定の意味を持つ
−例としてファイル data.sql の中身は
<syntaxhighlight lang="sql">
<syntaxhighlight lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
Line 102:
Line 104:
</syntaxhighlight>
</syntaxhighlight>
−ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.
−===Test your .sql files===
+===自前の .sql ファイルをテストする===
−ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.
−===Generate the PHP DAO class===
+===PHP DAO クラスを生成===
−DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.
−だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず '''htdocs/modulebuilder/templates/class/myobject.class.php'''
−このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.
−==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 ...)
+'''使用場面''': オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合
−そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:
<syntaxhighlight lang="php">
<syntaxhighlight lang="php">
Line 129:
Line 131:
</syntaxhighlight>
</syntaxhighlight>
−テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分からなる．
−*Part 1: The element type (object type) where the tab should appear is a value from the following:
+*Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
−{{TemplateModuleTabs}}
+{{TemplateModuleTabsJA}}
−*Part 2: A code to identify tab to add (start with +) or to remove (start with -)
+*Part 2: タブのコードで、タブの追加（+で始まる）または削除（-で始まる）を識別する．
−*Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
+*Part 3: タブのタイトル．タイトルが読みずらいなら、コードにして言語ファイルで翻訳するとよい．
−*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 4: ファイル名 "*.lang" は、コード翻訳と表示する言語の対応を含む．この名前の後に@mymoduleが続く場合、 Dolibarrはモジュール内の翻訳ファイル "*.lang "を検索するので、htdocs/mymodule/langs/code_CODE/mylangfile.langとなり、そうでない場合はhtdocs/langs/code_CODE/mylangfile.langとなる．
−*Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
+*Part 5: タブを常時表示すべきかのテスト条件．常時表示の場合は1を指定．
−*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.
+*Part 6: タブをクリックしたときに表示されるページのURL。__ID__の文字列は自動的に当該要素のIdに置き換えられる．
−タブの内容へデータベースからのデータを注入するには、次章を参照．
−既存タブの名前 'tabname' を取得するには、ファイル 'core/lib/module.lib.php' の関数 'product_prepare_head' で使用されている名前で、セクション '$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.
+'''使用場面''': 自前ページにオブジェクト(製品、階層、など)の標準タブを表示したい
−以下の手順に従う :
'''1. Include files you need into your file'''
'''1. Include files you need into your file'''
Line 217:
Line 218:
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.
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)==
+==PHP 画面の作成や更新 (任意)==
−使用場面: モジュールの目的が、画面の新規作成または変更を必要とする機能の追加である場合.
−===Create a new PHP screen===
+===新規 PHP 画面の作成===
−次に、 '''modulebuilder/myobject_page.php''' ディレクトリに例として提示されているスケルトンテンプレートを使用して、テーブルのデータを表示/編集するPHPページを作成する必要がある (コマンドラインからのスクリプト開発については、 [[Script development]] を参照).
−新しいユーザー画面を作成するには、'''htdocs''' のサブディレクトリを作成し（まだ作成されていない場合）、作成するページを保存するために、モジュール（例えば、'''htdocs/mymodule''' ）のサブディレクトリを作成する.
−そのディレクトリに、ページファイルの出発点となるファイル '''myobject_page.php''' をコピーする。.
−main.inc.phpファイルへの相対パスが正しくなるようにファイルを編集する.
<syntaxhighlight lang="php">
<syntaxhighlight lang="php">
// Load Dolibarr environment
// Load Dolibarr environment
Line 243:
Line 244:
if (! $res) die("Include of main fails");
if (! $res) die("Include of main fails");
</syntaxhighlight>
</syntaxhighlight>
−ご覧のように、main.inc.php（または master.inc.php）のロードは何回か試行される。目標は、大抵のケースで成功すること。最小は2行: master/main.inc.phpをdolibarrルートディレクトリにロードしようとする行と、モジュールが "custom "ディレクトリにデプロイされるケースをサポートするためにファイルをロードしようとする行。しかし、より多くの状況に対応するため、より多くを持つことができる。提供された例は、ほぼすべての状況/セットアップで main/master.inc.php ファイルをロードできるはず。
−注意： モジュール・ディレクトリ・ツリーに対するファイルの深さによっては、さらに"../"を追加する。
−main.inc.phpファイルでは、技術上の環境変数とパーミッションを読み込む。以下の変数はこのファイルに配置されているオブジェクト：
−*$user Object that contains the characteristics of the user + his permissions.
+*$user ユーザーの特徴とパーミッションを保持するオブジェクト。
−*$conf Object that contains Dolibarr configuration.
+*$conf Dolibarrの設定を保持するオブジェクト
−*$db Object that contains an opened connection handler to the database.
+*$db データベースへのオープンされた接続ハンドラを保持するオブジェクト。
−*$langs Object that contains the user's language.
+*$langs ユーザー言語を保持するオブジェクト。
−次にページを表示するために自前コードを入力する.
−*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
+*モジュール専用クラスやライブラリをインクルードするには、（include_onceを直接使わず）Dolibarr関数を使う：
''Example :''
''Example :''
Line 263:
Line 264:
</syntaxhighlight>
</syntaxhighlight>
−*To include classes provided with Dolibarr, use the following syntax:
+*Dolibarrで提供されているクラスをインクルードするには、以下の構文を使う:
''Example :''
''Example :''
Line 286:
Line 287:
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.
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===
+===データベース アクセス===
−自前テーブルの中でデータベースのデータを編集する必要がある場合、前に生成されたPHPクラスを使うこと。
−専用の PHP クラスがないテーブルにアクセスしたい場合 (たとえば、特定の結合やフィルタを使用したレコードの一覧を取得したい場合など) 、これはいつでも可能。この場合に、倣うべきコード例は：
−操作が、 insert, update または delete:
<syntaxhighlight lang="php">
<syntaxhighlight lang="php">
Line 300:
Line 301:
</syntaxhighlight>
</syntaxhighlight>
−操作が read:
<syntaxhighlight lang="php">
<syntaxhighlight lang="php">
Line 359:
Line 360:
as soon as the module is activate, the tpl will be overwrited
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.
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.
Line 382:
Line 383:
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.
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.
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.
Line 433:
Line 434:
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).
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.
'''When''': If you want to add new permissions.
Line 465:
Line 466:
</syntaxhighlight>
</syntaxhighlight>
−==Define your own box (optional)==
+==自前の box を定義 (任意)==
'''When''': If your module needs to provide one or several new boxes to show on home page.
'''When''': If your module needs to provide one or several new boxes to show on home page.
Line 490:
Line 491:
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.
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).
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).
Line 501:
Line 502:
Choose on field and try to build an export file. If ok, try again with all fields.
Choose on field and try to build an export file. If ok, try again with all fields.
−==Define your CSS styles (optional)==
+==自前の CSS スタイルを定義 (任意)==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).
Line 522:
Line 523:
You should see into the HTML header, a line that declares your style sheet.
You should see into the HTML header, a line that declares your style sheet.
−==Add your Javascript functions (optional)==
+==自前の Javascript 関数を追加 (任意)==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)
Line 534:
Line 535:
</syntaxhighlight>
</syntaxhighlight>
−==Run your own code on any Dolibarr event (optional)==
+==いずれかの 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'''.
'''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'''.
Line 540:
Line 541:
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]
−==Insert your code inside Dolibarr hooks positions (optional)==
+==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).
'''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).
Line 546:
Line 547:
−==Add your own numbering rules==
+==自前の番号付けルールを追加==
'''When''': When you need a new rule for generated ref of elements that are not covered by existing 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]].
See page [[Create numbering module]].
−==Add your document template (optional)==
+==自前の文書テンプレートを追加 (任意)==
'''When''': When you want to personalized your own generated PDF or ODT documents.
'''When''': When you want to personalized your own generated PDF or ODT documents.
Line 558:
Line 559:
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].
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.
'''When''': When you want to personalized your colors/fonts/images.
Line 565:
Line 566:
To add your own skin, read page [[Skins]].
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".
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".
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.
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.
But you can use it to have a package easy to distribute on your own network.
Line 595:
Line 596:
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).
**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=
+=DoliStore での外部モジュール 有効化/活性化 条件=
See [[Module_Dolistore_Validation_Rules|Validation Rules]]
See [[Module_Dolistore_Validation_Rules|Validation Rules]]
[[Category:Development]]
[[Category:Development]]