モジュール 開発
Dolibarr向け新規 モジュール/アドオン を作成するには, 複数のステップがある. このチュートリアルで記述するのは、Dolibarrの特質拡張用モジュールを作るステップのそれぞれである, 以下の１つとか、複数の組み合わせとかのように :
- データベースに新規テーブルを追加.
- 自前メニュー項目を追加.
- 新規テーブル編集用の新規画面を追加.
- オブジェクトビュー (請求,製品,注文,イベント, ...) に関わるタブの追加または削除.
- 内部エキスポートツール向けの事前定義済のエクスポートを追加.
- ホームページに新規情報ウィジェットを追加.
- 新規置換変数を追加.
- 新規許認可を定義.
- 特定の Dolibarr アクションにより自動トリガされるコードを実行.
- Dolibarr フックポジション内に自分のコードを挿入.
- オブジェクト参照を生成するための自前の番号付けルールを追加
- 新規文書テンプレートを追加.
- 新規スキンを追加.
etc...
以下の章では、これらすべてを手作業で簡単に行う方法を示す.
モジュールビルダ によるモジュールの生成
Dolibarr 9.0 から、モジュールビルダにより、自前モジュールのメインページ作成が可能. 起動方法は:
- モジュールリストにて、"モジュールビルダ(Module Builder)"を有効化する,
- その後 "バグ(bug)" 画像をクリック、場所は画面右上.
テンプレート外部モジュールの例
外部モジュールの開発を開始するのによいお手本は、ここで見つかるだろう : 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.
- コンストラクタで定義されたその他の変数（意味についてはコード雛形のコメントを参照）を変更.
自前モジュールのファイルディスクリプタの準備ができた。有効化するには次ステップを参照.
自前記述をテストする
Dolibarrを起動し、設定->モジュール (Setup->module?) ページを表示. モジュール記述でプロパティバージョン (property version) を設定すると、自前の新規モジュールを載せた新規行とそれを有効化するかどうかの選択が表示されるはず. プロパティバージョンを "develop" または "experimental" に設定した場合、自前モジュールを見るには、まず 設定->その他 (Setup-Others) に行き、 MAIN_FEATURES_LEVEL を 1 に設定してから "experimental" モジュールを見るか、2にして から "development" モジュールを見るかする必要がある.
新規モジュールファイルに関するパスツリー (必須)
これは、新しいモジュールを構築する際に、ファイルをどう整理するかを示している (ZIPファイルもこのルールに合わせる必要あり). 注：2行目だけが必須.
- 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 モジュールが自前のテーマ/スキンを提供する場合
自前 SQL テーブル と PHP DAO クラス (任意)
使用場面: 自前モジュールがそれ自身のデータを管理する必要がある場合
自前の .sql ファイルを作成
自前モジュールが、Dolibarr標準版では利用できない独自データを管理する設計である場合、そのデータを格納するためのSQLテーブルを定義する必要がある.
自前モジュールでテーブルを作成したり、データを読込むためのスクリプトは、自前モジュールのsqlサブディレクトリ ("mymodule/sql") に保存される。(ModuleBuilder では、オブジェクト タブから新しいオブジェクトを作成するとき、このディレクトリとすべての sql ファイルが自動作成される）.
次に、記述ファイルでの、init 関数にて、次の行
$this->_load_tables('/mymodule/sql/');
が、コメントでないことを確認する.
従うべきルール:
- テーブルごとに 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 の中身は
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__');
ファイルは、mysql データベースで動作可能であること. 備考: 他データベースのファイルはメンテナンスされない. 他データベースのドライバによって、その場で読込まれ変換さる.
自前の .sql ファイルをテストする
ファイルの準備ができたら、Dolibarrモジュールを有効にするページに戻り、モジュールを無効にして、データベース内のそれらのテーブルを削除し（すでに存在している場合）、モジュールを再有効化することができる。モジュールの有効化により、テーブルが再作成されるはず。もしそうでない場合、スクリプトを手で渡して確認するか、Dolibarrのログを確認すること.
PHP DAO クラスを生成
DAO PHPファイルは、オブジェクトを作成した後にモジュールビルダによって生成されているはず.
だとしても、既存オブジェクトをコピーして手動作成することもできる、しかし、モジュールビルダの使用を強く勧める。実例がここにあるはず htdocs/modulebuilder/templates/class/myobject.class.php
このクラスでは、テーブル行の挿入、取得（選択）、更新、削除を実行するためのCRUD（作成/読込/更新/削除）メソッドがすでに実行可能となっている。正しいモジュール名、テーブルを使用するようにファイルを編集し、このファイルをモジュールのクラスサブディレクトリに配置する。モジュールビルダを使用すると、マウスを数回クリックするだけで、この作業を実行できる.
タブ管理 (任意)
オブジェクトシートに自前のタブを追加・削除できる
使用場面: オブジェクト（請求書、注文書、提案書、メンバー...）にタブを追加する場合
そのためには、先に作成したモジュールのファイル記述に行って、$this->tabs 配列を編集する:
// 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
テーブルには文字列のリストが含まれ、各文字列は新しいタブを表す．文字列の形式は ": " で区切られた5つの部分からなる．
- Part 1: タブを表示するエレメントタイプ（オブジェクトタイプ）で、以下の値:
- '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) に変更)
- 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
require_once($url_fichier) ;
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 :
$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
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
$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
Example :
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
4. show tabs into your page
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().
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
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ファイルへの相対パスが正しくなるようにファイルを編集する.
// 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");
ご覧のように、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 :
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
- Dolibarrで提供されているクラスをインクルードするには、以下の構文を使う:
Example :
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
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:
|
|
Page waiting to complete. To complete, create an account, go back and clic on "Modify".
Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
Seite wartet auf Vervollständigung. Um zu helfen, erstelle ein Konto, gehe zurück und klicke auf "Bearbeiten".
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:
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
操作が read:
$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++;
}
}
}
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:
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
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:
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));
print strftime('%A %d %B %Y', $mydate);
Overwrite template file (tpl)
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :
'tpl' => 1,
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). 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:
$this->config_page_url = array("mymodule_setuppage.php");
If the page is in the directory mymodule/admin/, then like this:
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
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.
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:
// 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++;
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.
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
$this->rights_class = 'mymodule'
with correct value for mymodule.
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.
$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++;
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:
if ($user->rights->mymodule->action->subaction) ...
自前の 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:
$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'
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
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));
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 :
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
いずれかの 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):
perl makepack-dolibarrmodule.pl
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:
tar -xvf mymodule.zip
- If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: DoliStore.com (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 Validation Rules